Файловый менеджер - Редактировать - /home/clickysoft/public_html/jmapi5.clickysoft.net/getbrevo.tar
Назад
brevo-php/phpunit.xml.dist 0000755 00000001246 15021222673 0011627 0 ustar 00 <?xml version="1.0" encoding="UTF-8"?> <phpunit bootstrap="./vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false"> <testsuites> <testsuite> <directory>./test/Api</directory> <directory>./test/Model</directory> </testsuite> </testsuites> <filter> <whitelist processUncoveredFilesFromWhitelist="true"> <directory suffix=".php">./lib/Api</directory> <directory suffix=".php">./lib/Model</directory> </whitelist> </filter> </phpunit> brevo-php/composer.json 0000755 00000002011 15021222673 0011165 0 ustar 00 { "name": "getbrevo/brevo-php", "description": "Official Brevo provided RESTFul API V3 php library", "keywords": [ "brevo", "swagger", "php", "sdk", "api" ], "homepage": "https://github.com/getbrevo/brevo-php", "license": "MIT", "authors": [ { "name": "Brevo Developers", "email": "contact@brevo.com", "homepage": "https://www.brevo.com/" } ], "require": { "php": ">=5.6", "ext-curl": "*", "ext-json": "*", "ext-mbstring": "*", "guzzlehttp/guzzle": "^7.4.0" }, "require-dev": { "phpunit/phpunit": "^4.8", "squizlabs/php_codesniffer": "~2.6", "friendsofphp/php-cs-fixer": "~1.12" }, "autoload": { "psr-4": { "Brevo\\Client\\" : "lib/" } }, "autoload-dev": { "psr-4": { "Brevo\\Client\\" : "test/" } }, "extra": { "branch-alias": { "dev-master": "1.x.x-dev" } } } brevo-php/.gitignore 0000644 00000000020 15021222673 0010426 0 ustar 00 .DS_Store vendor brevo-php/docs/Api/WhatsAppCampaignsApi.md 0000644 00000056225 15021222673 0014447 0 ustar 00 # Brevo\Client\WhatsAppCampaignsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createWhatsAppCampaign**](WhatsAppCampaignsApi.md#createWhatsAppCampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign [**createWhatsAppTemplate**](WhatsAppCampaignsApi.md#createWhatsAppTemplate) | **POST** /whatsappCampaigns/template | Create a WhatsApp template [**deleteWhatsAppCampaign**](WhatsAppCampaignsApi.md#deleteWhatsAppCampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign [**getWhatsAppCampaign**](WhatsAppCampaignsApi.md#getWhatsAppCampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign [**getWhatsAppCampaigns**](WhatsAppCampaignsApi.md#getWhatsAppCampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns [**getWhatsAppConfig**](WhatsAppCampaignsApi.md#getWhatsAppConfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information [**getWhatsAppTemplates**](WhatsAppCampaignsApi.md#getWhatsAppTemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates [**sendWhatsAppTemplateApproval**](WhatsAppCampaignsApi.md#sendWhatsAppTemplateApproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval [**updateWhatsAppCampaign**](WhatsAppCampaignsApi.md#updateWhatsAppCampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign # **createWhatsAppCampaign** > \Brevo\Client\Model\CreateModel createWhatsAppCampaign($whatsAppCampaigns) Create and Send a WhatsApp campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $whatsAppCampaigns = new \Brevo\Client\Model\CreateWhatsAppCampaign(); // \Brevo\Client\Model\CreateWhatsAppCampaign | Values to create a campaign try { $result = $apiInstance->createWhatsAppCampaign($whatsAppCampaigns); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->createWhatsAppCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **whatsAppCampaigns** | [**\Brevo\Client\Model\CreateWhatsAppCampaign**](../Model/CreateWhatsAppCampaign.md)| Values to create a campaign | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createWhatsAppTemplate** > \Brevo\Client\Model\CreateModel createWhatsAppTemplate($whatsAppTemplates) Create a WhatsApp template ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $whatsAppTemplates = new \Brevo\Client\Model\CreateWhatsAppTemplate(); // \Brevo\Client\Model\CreateWhatsAppTemplate | Values to create a template try { $result = $apiInstance->createWhatsAppTemplate($whatsAppTemplates); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->createWhatsAppTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **whatsAppTemplates** | [**\Brevo\Client\Model\CreateWhatsAppTemplate**](../Model/CreateWhatsAppTemplate.md)| Values to create a template | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteWhatsAppCampaign** > deleteWhatsAppCampaign($campaignId) Delete a WhatsApp campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign try { $apiInstance->deleteWhatsAppCampaign($campaignId); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->deleteWhatsAppCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWhatsAppCampaign** > \Brevo\Client\Model\GetWhatsappCampaignOverview getWhatsAppCampaign($campaignId) Get a WhatsApp campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign try { $result = $apiInstance->getWhatsAppCampaign($campaignId); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | ### Return type [**\Brevo\Client\Model\GetWhatsappCampaignOverview**](../Model/GetWhatsappCampaignOverview.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWhatsAppCampaigns** > \Brevo\Client\Model\GetWhatsappCampaigns getWhatsAppCampaigns($startDate, $endDate, $limit, $offset, $sort) Return all your created WhatsApp campaigns ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $startDate = "startDate_example"; // string | **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** $endDate = "endDate_example"; // string | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getWhatsAppCampaigns($startDate, $endDate, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppCampaigns: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** | [optional] **endDate** | **string**| **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetWhatsappCampaigns**](../Model/GetWhatsappCampaigns.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWhatsAppConfig** > \Brevo\Client\Model\GetWhatsAppConfig getWhatsAppConfig() Get your WhatsApp API account information ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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->getWhatsAppConfig(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppConfig: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetWhatsAppConfig**](../Model/GetWhatsAppConfig.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWhatsAppTemplates** > \Brevo\Client\Model\GetWATemplates getWhatsAppTemplates($startDate, $endDate, $limit, $offset, $sort) Return all your created WhatsApp templates ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $startDate = "startDate_example"; // string | **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** $endDate = "endDate_example"; // string | **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getWhatsAppTemplates($startDate, $endDate, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->getWhatsAppTemplates: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** | [optional] **endDate** | **string**| **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetWATemplates**](../Model/GetWATemplates.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendWhatsAppTemplateApproval** > sendWhatsAppTemplateApproval($templateId) Send your WhatsApp template for approval ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $templateId = 789; // int | id of the campaign try { $apiInstance->sendWhatsAppTemplateApproval($templateId); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->sendWhatsAppTemplateApproval: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **int**| id of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateWhatsAppCampaign** > updateWhatsAppCampaign($campaignId, $whatsAppCampaign) Update a WhatsApp campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WhatsAppCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $whatsAppCampaign = new \Brevo\Client\Model\UpdateWhatsAppCampaign(); // \Brevo\Client\Model\UpdateWhatsAppCampaign | values to update WhatsApp Campaign try { $apiInstance->updateWhatsAppCampaign($campaignId, $whatsAppCampaign); } catch (Exception $e) { echo 'Exception when calling WhatsAppCampaignsApi->updateWhatsAppCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **whatsAppCampaign** | [**\Brevo\Client\Model\UpdateWhatsAppCampaign**](../Model/UpdateWhatsAppCampaign.md)| values to update WhatsApp Campaign | [optional] ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/EcommerceApi.md 0000644 00000066272 15021222673 0012777 0 ustar 00 # Brevo\Client\EcommerceApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createBatchOrder**](EcommerceApi.md#createBatchOrder) | **POST** /orders/status/batch | Create orders in batch [**createOrder**](EcommerceApi.md#createOrder) | **POST** /orders/status | Managing the status of the order [**createUpdateBatchCategory**](EcommerceApi.md#createUpdateBatchCategory) | **POST** /categories/batch | Create categories in batch [**createUpdateBatchProducts**](EcommerceApi.md#createUpdateBatchProducts) | **POST** /products/batch | Create products in batch [**createUpdateCategory**](EcommerceApi.md#createUpdateCategory) | **POST** /categories | Create/Update a category [**createUpdateProduct**](EcommerceApi.md#createUpdateProduct) | **POST** /products | Create/Update a product [**ecommerceActivatePost**](EcommerceApi.md#ecommerceActivatePost) | **POST** /ecommerce/activate | Activate the eCommerce app [**getCategories**](EcommerceApi.md#getCategories) | **GET** /categories | Return all your categories [**getCategoryInfo**](EcommerceApi.md#getCategoryInfo) | **GET** /categories/{id} | Get a category details [**getProductInfo**](EcommerceApi.md#getProductInfo) | **GET** /products/{id} | Get a product's details [**getProducts**](EcommerceApi.md#getProducts) | **GET** /products | Return all your products # **createBatchOrder** > createBatchOrder($orderBatch) Create orders in batch Create multiple orders at one time instead of one order at a time ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $orderBatch = new \Brevo\Client\Model\OrderBatch(); // \Brevo\Client\Model\OrderBatch | try { $apiInstance->createBatchOrder($orderBatch); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createBatchOrder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderBatch** | [**\Brevo\Client\Model\OrderBatch**](../Model/OrderBatch.md)| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createOrder** > createOrder($order) Managing the status of the order Manages the transactional status of the order ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $order = new \Brevo\Client\Model\Order(); // \Brevo\Client\Model\Order | try { $apiInstance->createOrder($order); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createOrder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order** | [**\Brevo\Client\Model\Order**](../Model/Order.md)| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createUpdateBatchCategory** > \Brevo\Client\Model\CreateUpdateBatchCategoryModel createUpdateBatchCategory($createUpdateBatchCategory) Create categories in batch ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $createUpdateBatchCategory = new \Brevo\Client\Model\CreateUpdateBatchCategory(); // \Brevo\Client\Model\CreateUpdateBatchCategory | Values to create a batch of categories try { $result = $apiInstance->createUpdateBatchCategory($createUpdateBatchCategory); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createUpdateBatchCategory: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createUpdateBatchCategory** | [**\Brevo\Client\Model\CreateUpdateBatchCategory**](../Model/CreateUpdateBatchCategory.md)| Values to create a batch of categories | ### Return type [**\Brevo\Client\Model\CreateUpdateBatchCategoryModel**](../Model/CreateUpdateBatchCategoryModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createUpdateBatchProducts** > \Brevo\Client\Model\CreateUpdateBatchProductsModel createUpdateBatchProducts($createUpdateBatchProducts) Create products in batch ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $createUpdateBatchProducts = new \Brevo\Client\Model\CreateUpdateBatchProducts(); // \Brevo\Client\Model\CreateUpdateBatchProducts | Values to create a batch of products try { $result = $apiInstance->createUpdateBatchProducts($createUpdateBatchProducts); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createUpdateBatchProducts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createUpdateBatchProducts** | [**\Brevo\Client\Model\CreateUpdateBatchProducts**](../Model/CreateUpdateBatchProducts.md)| Values to create a batch of products | ### Return type [**\Brevo\Client\Model\CreateUpdateBatchProductsModel**](../Model/CreateUpdateBatchProductsModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createUpdateCategory** > \Brevo\Client\Model\CreateCategoryModel createUpdateCategory($createUpdateCategory) Create/Update a category ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $createUpdateCategory = new \Brevo\Client\Model\CreateUpdateCategory(); // \Brevo\Client\Model\CreateUpdateCategory | Values to create/update a category try { $result = $apiInstance->createUpdateCategory($createUpdateCategory); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createUpdateCategory: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createUpdateCategory** | [**\Brevo\Client\Model\CreateUpdateCategory**](../Model/CreateUpdateCategory.md)| Values to create/update a category | ### Return type [**\Brevo\Client\Model\CreateCategoryModel**](../Model/CreateCategoryModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createUpdateProduct** > \Brevo\Client\Model\CreateProductModel createUpdateProduct($createUpdateProduct) Create/Update a product ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $createUpdateProduct = new \Brevo\Client\Model\CreateUpdateProduct(); // \Brevo\Client\Model\CreateUpdateProduct | Values to create/update a product try { $result = $apiInstance->createUpdateProduct($createUpdateProduct); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->createUpdateProduct: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createUpdateProduct** | [**\Brevo\Client\Model\CreateUpdateProduct**](../Model/CreateUpdateProduct.md)| Values to create/update a product | ### Return type [**\Brevo\Client\Model\CreateProductModel**](../Model/CreateProductModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **ecommerceActivatePost** > ecommerceActivatePost() Activate the eCommerce app Getting access to Brevo eCommerce. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 { $apiInstance->ecommerceActivatePost(); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->ecommerceActivatePost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getCategories** > \Brevo\Client\Model\GetCategories getCategories($limit, $offset, $sort, $ids, $name) Return all your categories ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed $ids = array("ids_example"); // string[] | Filter by category ids $name = "name_example"; // string | Filter by category name try { $result = $apiInstance->getCategories($limit, $offset, $sort, $ids, $name); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->getCategories: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] **ids** | [**string[]**](../Model/string.md)| Filter by category ids | [optional] **name** | **string**| Filter by category name | [optional] ### Return type [**\Brevo\Client\Model\GetCategories**](../Model/GetCategories.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getCategoryInfo** > \Brevo\Client\Model\GetCategoryDetails getCategoryInfo($id) Get a category details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $id = "id_example"; // string | Category ID try { $result = $apiInstance->getCategoryInfo($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->getCategoryInfo: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Category ID | ### Return type [**\Brevo\Client\Model\GetCategoryDetails**](../Model/GetCategoryDetails.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getProductInfo** > \Brevo\Client\Model\GetProductDetails getProductInfo($id) Get a product's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $id = "id_example"; // string | Product ID try { $result = $apiInstance->getProductInfo($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->getProductInfo: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Product ID | ### Return type [**\Brevo\Client\Model\GetProductDetails**](../Model/GetProductDetails.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getProducts** > \Brevo\Client\Model\GetProducts getProducts($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories) Return all your products ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EcommerceApi( // 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 ); $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed $ids = array("ids_example"); // string[] | Filter by product ids $name = "name_example"; // string | Filter by product name, minimum 3 characters should be present for search $priceLte = 8.14; // float | Price filter for products less than and equals to particular amount $priceGte = 8.14; // float | Price filter for products greater than and equals to particular amount $priceLt = 8.14; // float | Price filter for products less than particular amount $priceGt = 8.14; // float | Price filter for products greater than particular amount $priceEq = 8.14; // float | Price filter for products equals to particular amount $priceNe = 8.14; // float | Price filter for products not equals to particular amount $categories = array("categories_example"); // string[] | Filter by category ids try { $result = $apiInstance->getProducts($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories); print_r($result); } catch (Exception $e) { echo 'Exception when calling EcommerceApi->getProducts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] **ids** | [**string[]**](../Model/string.md)| Filter by product ids | [optional] **name** | **string**| Filter by product name, minimum 3 characters should be present for search | [optional] **priceLte** | **float**| Price filter for products less than and equals to particular amount | [optional] **priceGte** | **float**| Price filter for products greater than and equals to particular amount | [optional] **priceLt** | **float**| Price filter for products less than particular amount | [optional] **priceGt** | **float**| Price filter for products greater than particular amount | [optional] **priceEq** | **float**| Price filter for products equals to particular amount | [optional] **priceNe** | **float**| Price filter for products not equals to particular amount | [optional] **categories** | [**string[]**](../Model/string.md)| Filter by category ids | [optional] ### Return type [**\Brevo\Client\Model\GetProducts**](../Model/GetProducts.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ListsApi.md 0000644 00000053177 15021222673 0012176 0 ustar 00 # Brevo\Client\ListsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**addContactToList**](ListsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list [**createList**](ListsApi.md#createList) | **POST** /contacts/lists | Create a list [**deleteList**](ListsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list [**getContactsFromList**](ListsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list [**getFolderLists**](ListsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder [**getList**](ListsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details [**getLists**](ListsApi.md#getLists) | **GET** /contacts/lists | Get all the lists [**removeContactFromList**](ListsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**updateList**](ListsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list # **addContactToList** > \Brevo\Client\Model\PostContactInfo addContactToList($listId, $contactEmails) Add existing contacts to a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list $contactEmails = new \Brevo\Client\Model\AddContactToList(); // \Brevo\Client\Model\AddContactToList | Emails addresses OR IDs of the contacts try { $result = $apiInstance->addContactToList($listId, $contactEmails); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->addContactToList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **contactEmails** | [**\Brevo\Client\Model\AddContactToList**](../Model/AddContactToList.md)| Emails addresses OR IDs of the contacts | ### Return type [**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createList** > \Brevo\Client\Model\CreateModel createList($createList) Create a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $createList = new \Brevo\Client\Model\CreateList(); // \Brevo\Client\Model\CreateList | Values to create a list try { $result = $apiInstance->createList($createList); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->createList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createList** | [**\Brevo\Client\Model\CreateList**](../Model/CreateList.md)| Values to create a list | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteList** > deleteList($listId) Delete a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list try { $apiInstance->deleteList($listId); } catch (Exception $e) { echo 'Exception when calling ListsApi->deleteList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getContactsFromList** > \Brevo\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort) Get contacts in a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list $modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetContacts**](../Model/GetContacts.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolderLists** > \Brevo\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort) Get lists in a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $folderId = 789; // int | Id of the folder $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->getFolderLists: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetFolderLists**](../Model/GetFolderLists.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getList** > \Brevo\Client\Model\GetExtendedList getList($listId) Get a list's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list try { $result = $apiInstance->getList($listId); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->getList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | ### Return type [**\Brevo\Client\Model\GetExtendedList**](../Model/GetExtendedList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getLists** > \Brevo\Client\Model\GetLists getLists($limit, $offset, $sort) Get all the lists ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getLists($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->getLists: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetLists**](../Model/GetLists.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **removeContactFromList** > \Brevo\Client\Model\PostContactInfo removeContactFromList($listId, $contactEmails) Delete a contact from a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list $contactEmails = new \Brevo\Client\Model\RemoveContactFromList(); // \Brevo\Client\Model\RemoveContactFromList | Emails addresses OR IDs of the contacts try { $result = $apiInstance->removeContactFromList($listId, $contactEmails); print_r($result); } catch (Exception $e) { echo 'Exception when calling ListsApi->removeContactFromList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **contactEmails** | [**\Brevo\Client\Model\RemoveContactFromList**](../Model/RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | ### Return type [**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateList** > updateList($listId, $updateList) Update a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ListsApi( // 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 ); $listId = 789; // int | Id of the list $updateList = new \Brevo\Client\Model\UpdateList(); // \Brevo\Client\Model\UpdateList | Values to update a list try { $apiInstance->updateList($listId, $updateList); } catch (Exception $e) { echo 'Exception when calling ListsApi->updateList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **updateList** | [**\Brevo\Client\Model\UpdateList**](../Model/UpdateList.md)| Values to update a list | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ExternalFeedsApi.md 0000644 00000032167 15021222673 0013625 0 ustar 00 # Brevo\Client\ExternalFeedsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createExternalFeed**](ExternalFeedsApi.md#createExternalFeed) | **POST** /feeds | Create an external feed [**deleteExternalFeed**](ExternalFeedsApi.md#deleteExternalFeed) | **DELETE** /feeds/{uuid} | Delete an external feed [**getAllExternalFeeds**](ExternalFeedsApi.md#getAllExternalFeeds) | **GET** /feeds | Fetch all external feeds [**getExternalFeedByUUID**](ExternalFeedsApi.md#getExternalFeedByUUID) | **GET** /feeds/{uuid} | Get an external feed by UUID [**updateExternalFeed**](ExternalFeedsApi.md#updateExternalFeed) | **PUT** /feeds/{uuid} | Update an external feed # **createExternalFeed** > \Brevo\Client\Model\InlineResponse2014 createExternalFeed($createExternalFeed) Create an external feed This endpoint will create an external feed. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ExternalFeedsApi( // 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 ); $createExternalFeed = new \Brevo\Client\Model\CreateExternalFeed(); // \Brevo\Client\Model\CreateExternalFeed | Values to create a feed try { $result = $apiInstance->createExternalFeed($createExternalFeed); print_r($result); } catch (Exception $e) { echo 'Exception when calling ExternalFeedsApi->createExternalFeed: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createExternalFeed** | [**\Brevo\Client\Model\CreateExternalFeed**](../Model/CreateExternalFeed.md)| Values to create a feed | ### Return type [**\Brevo\Client\Model\InlineResponse2014**](../Model/InlineResponse2014.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteExternalFeed** > deleteExternalFeed($uuid) Delete an external feed This endpoint will delete an external feed. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ExternalFeedsApi( // 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 ); $uuid = "uuid_example"; // string | UUID of the feed to delete try { $apiInstance->deleteExternalFeed($uuid); } catch (Exception $e) { echo 'Exception when calling ExternalFeedsApi->deleteExternalFeed: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uuid** | **string**| UUID of the feed to delete | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAllExternalFeeds** > \Brevo\Client\Model\GetAllExternalFeeds getAllExternalFeeds($search, $startDate, $endDate, $sort, $authType, $limit, $offset) Fetch all external feeds This endpoint can fetch all created external feeds. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ExternalFeedsApi( // 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 ); $search = "search_example"; // string | Can be used to filter records by search keyword on feed name $startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. $endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. $authType = "authType_example"; // string | Filter the records by `authType` of the feed. $limit = 50; // int | Number of documents returned per page. $offset = 0; // int | Index of the first document on the page. try { $result = $apiInstance->getAllExternalFeeds($search, $startDate, $endDate, $sort, $authType, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling ExternalFeedsApi->getAllExternalFeeds: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **search** | **string**| Can be used to filter records by search keyword on feed name | [optional] **startDate** | **\DateTime**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. | [optional] **endDate** | **\DateTime**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. | [optional] [default to desc] **authType** | **string**| Filter the records by `authType` of the feed. | [optional] **limit** | **int**| Number of documents returned per page. | [optional] [default to 50] **offset** | **int**| Index of the first document on the page. | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetAllExternalFeeds**](../Model/GetAllExternalFeeds.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getExternalFeedByUUID** > \Brevo\Client\Model\GetExternalFeedByUUID getExternalFeedByUUID($uuid) Get an external feed by UUID This endpoint will update an external feed. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ExternalFeedsApi( // 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 ); $uuid = "uuid_example"; // string | UUID of the feed to fetch try { $result = $apiInstance->getExternalFeedByUUID($uuid); print_r($result); } catch (Exception $e) { echo 'Exception when calling ExternalFeedsApi->getExternalFeedByUUID: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uuid** | **string**| UUID of the feed to fetch | ### Return type [**\Brevo\Client\Model\GetExternalFeedByUUID**](../Model/GetExternalFeedByUUID.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateExternalFeed** > updateExternalFeed($uuid, $updateExternalFeed) Update an external feed This endpoint will update an external feed. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ExternalFeedsApi( // 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 ); $uuid = "uuid_example"; // string | UUID of the feed to update $updateExternalFeed = new \Brevo\Client\Model\UpdateExternalFeed(); // \Brevo\Client\Model\UpdateExternalFeed | Values to update a feed try { $apiInstance->updateExternalFeed($uuid, $updateExternalFeed); } catch (Exception $e) { echo 'Exception when calling ExternalFeedsApi->updateExternalFeed: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uuid** | **string**| UUID of the feed to update | **updateExternalFeed** | [**\Brevo\Client\Model\UpdateExternalFeed**](../Model/UpdateExternalFeed.md)| Values to update a feed | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/InboundParsingApi.md 0000644 00000021313 15021222673 0014005 0 ustar 00 # Brevo\Client\InboundParsingApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getInboundEmailAttachment**](InboundParsingApi.md#getInboundEmailAttachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token. [**getInboundEmailEvents**](InboundParsingApi.md#getInboundEmailEvents) | **GET** /inbound/events | Get the list of all the events for the received emails. [**getInboundEmailEventsByUuid**](InboundParsingApi.md#getInboundEmailEventsByUuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email. # **getInboundEmailAttachment** > \SplFileObject getInboundEmailAttachment($downloadToken) Retrieve inbound attachment with download token. This endpoint will retrieve inbound attachment with download token. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\InboundParsingApi( // 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 ); $downloadToken = "downloadToken_example"; // string | Token to fetch a particular attachment try { $result = $apiInstance->getInboundEmailAttachment($downloadToken); print_r($result); } catch (Exception $e) { echo 'Exception when calling InboundParsingApi->getInboundEmailAttachment: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **downloadToken** | **string**| Token to fetch a particular attachment | ### Return type [**\SplFileObject**](../Model/\SplFileObject.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getInboundEmailEvents** > \Brevo\Client\Model\GetInboundEmailEvents getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort) Get the list of all the events for the received emails. This endpoint will show the list of all the events for the received emails. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\InboundParsingApi( // 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 ); $sender = "sender_example"; // string | Email address of the sender. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. $limit = 100; // int | Number of documents returned per page $offset = 0; // int | Index of the first document on the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation try { $result = $apiInstance->getInboundEmailEvents($sender, $startDate, $endDate, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling InboundParsingApi->getInboundEmailEvents: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sender** | **string**| Email address of the sender. | [optional] **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **limit** | **int**| Number of documents returned per page | [optional] [default to 100] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetInboundEmailEvents**](../Model/GetInboundEmailEvents.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getInboundEmailEventsByUuid** > \Brevo\Client\Model\GetInboundEmailEventsByUuid getInboundEmailEventsByUuid($uuid) Fetch all events history for one particular received email. This endpoint will show the list of all events history for one particular received email. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\InboundParsingApi( // 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 ); $uuid = "uuid_example"; // string | UUID to fetch events specific to recieved email try { $result = $apiInstance->getInboundEmailEventsByUuid($uuid); print_r($result); } catch (Exception $e) { echo 'Exception when calling InboundParsingApi->getInboundEmailEventsByUuid: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uuid** | **string**| UUID to fetch events specific to recieved email | ### Return type [**\Brevo\Client\Model\GetInboundEmailEventsByUuid**](../Model/GetInboundEmailEventsByUuid.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ConversationsApi.md 0000644 00000050727 15021222673 0013733 0 ustar 00 # Brevo\Client\ConversationsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**conversationsAgentOnlinePingPost**](ConversationsApi.md#conversationsAgentOnlinePingPost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes [**conversationsMessagesIdDelete**](ConversationsApi.md#conversationsMessagesIdDelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent [**conversationsMessagesIdGet**](ConversationsApi.md#conversationsMessagesIdGet) | **GET** /conversations/messages/{id} | Get a message [**conversationsMessagesIdPut**](ConversationsApi.md#conversationsMessagesIdPut) | **PUT** /conversations/messages/{id} | Update a message sent by an agent [**conversationsMessagesPost**](ConversationsApi.md#conversationsMessagesPost) | **POST** /conversations/messages | Send a message as an agent [**conversationsPushedMessagesIdDelete**](ConversationsApi.md#conversationsPushedMessagesIdDelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message [**conversationsPushedMessagesIdGet**](ConversationsApi.md#conversationsPushedMessagesIdGet) | **GET** /conversations/pushedMessages/{id} | Get an automated message [**conversationsPushedMessagesIdPut**](ConversationsApi.md#conversationsPushedMessagesIdPut) | **PUT** /conversations/pushedMessages/{id} | Update an automated message [**conversationsPushedMessagesPost**](ConversationsApi.md#conversationsPushedMessagesPost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor # **conversationsAgentOnlinePingPost** > conversationsAgentOnlinePingPost($body) Sets agent’s status to online for 2-3 minutes We recommend pinging this endpoint every minute for as long as the agent has to be considered online. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 \Brevo\Client\Model\Body12(); // \Brevo\Client\Model\Body12 | Agent fields. try { $apiInstance->conversationsAgentOnlinePingPost($body); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsAgentOnlinePingPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body12**](../Model/Body12.md)| Agent fields. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsMessagesIdDelete** > conversationsMessagesIdDelete($id) Delete a message sent by an agent Only agents’ messages can be deleted. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message try { $apiInstance->conversationsMessagesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsMessagesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsMessagesIdGet** > \Brevo\Client\Model\ConversationsMessage conversationsMessagesIdGet($id) Get a message ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message try { $result = $apiInstance->conversationsMessagesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsMessagesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message | ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsMessagesIdPut** > \Brevo\Client\Model\ConversationsMessage conversationsMessagesIdPut($id, $body) Update a message sent by an agent Only agents’ messages can be edited. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message $body = new \Brevo\Client\Model\Body9(); // \Brevo\Client\Model\Body9 | try { $result = $apiInstance->conversationsMessagesIdPut($id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsMessagesIdPut: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message | **body** | [**\Brevo\Client\Model\Body9**](../Model/Body9.md)| | [optional] ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsMessagesPost** > \Brevo\Client\Model\ConversationsMessage conversationsMessagesPost($body) Send a message as an agent ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 \Brevo\Client\Model\Body8(); // \Brevo\Client\Model\Body8 | Message fields. try { $result = $apiInstance->conversationsMessagesPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsMessagesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body8**](../Model/Body8.md)| Message fields. | ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsPushedMessagesIdDelete** > conversationsPushedMessagesIdDelete($id) Delete an automated message ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message try { $apiInstance->conversationsPushedMessagesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsPushedMessagesIdGet** > \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesIdGet($id) Get an automated message ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message sent previously try { $result = $apiInstance->conversationsPushedMessagesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message sent previously | ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsPushedMessagesIdPut** > \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesIdPut($id, $body) Update an automated message ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 ); $id = "id_example"; // string | ID of the message $body = new \Brevo\Client\Model\Body11(); // \Brevo\Client\Model\Body11 | try { $result = $apiInstance->conversationsPushedMessagesIdPut($id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsPushedMessagesIdPut: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| ID of the message | **body** | [**\Brevo\Client\Model\Body11**](../Model/Body11.md)| | ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **conversationsPushedMessagesPost** > \Brevo\Client\Model\ConversationsMessage conversationsPushedMessagesPost($body) Send an automated message to a visitor Example of automated messages: order status, announce new features in your web app, etc. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ConversationsApi( // 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 \Brevo\Client\Model\Body10(); // \Brevo\Client\Model\Body10 | try { $result = $apiInstance->conversationsPushedMessagesPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConversationsApi->conversationsPushedMessagesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body10**](../Model/Body10.md)| | ### Return type [**\Brevo\Client\Model\ConversationsMessage**](../Model/ConversationsMessage.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/NotesApi.md 0000644 00000027022 15021222673 0012156 0 ustar 00 # Brevo\Client\NotesApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**crmNotesGet**](NotesApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes [**crmNotesIdDelete**](NotesApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note [**crmNotesIdGet**](NotesApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note [**crmNotesIdPatch**](NotesApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note [**crmNotesPost**](NotesApi.md#crmNotesPost) | **POST** /crm/notes | Create a note # **crmNotesGet** > \Brevo\Client\Model\NoteList crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) Get all notes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\NotesApi( // 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 ); $entity = "entity_example"; // string | Filter by note entity type $entityIds = "entityIds_example"; // string | Filter by note entity IDs $dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds) $dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds) $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed try { $result = $apiInstance->crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling NotesApi->crmNotesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entity** | **string**| Filter by note entity type | [optional] **entityIds** | **string**| Filter by note entity IDs | [optional] **dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] **dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] ### Return type [**\Brevo\Client\Model\NoteList**](../Model/NoteList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdDelete** > crmNotesIdDelete($id) Delete a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\NotesApi( // 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 ); $id = "id_example"; // string | Note ID to delete try { $apiInstance->crmNotesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling NotesApi->crmNotesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to delete | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdGet** > \Brevo\Client\Model\Note crmNotesIdGet($id) Get a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\NotesApi( // 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 ); $id = "id_example"; // string | Note ID to get try { $result = $apiInstance->crmNotesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling NotesApi->crmNotesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to get | ### Return type [**\Brevo\Client\Model\Note**](../Model/Note.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdPatch** > crmNotesIdPatch($id, $body) Update a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\NotesApi( // 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 ); $id = "id_example"; // string | Note ID to update $body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to update a note try { $apiInstance->crmNotesIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling NotesApi->crmNotesIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to update | **body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to update a note | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesPost** > \Brevo\Client\Model\NoteId crmNotesPost($body) Create a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\NotesApi( // 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 \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to create a note. try { $result = $apiInstance->crmNotesPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling NotesApi->crmNotesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to create a note. | ### Return type [**\Brevo\Client\Model\NoteId**](../Model/NoteId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/DomainsApi.md 0000644 00000025032 15021222673 0012457 0 ustar 00 # Brevo\Client\DomainsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**authenticateDomain**](DomainsApi.md#authenticateDomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain [**createDomain**](DomainsApi.md#createDomain) | **POST** /senders/domains | Create a new domain [**deleteDomain**](DomainsApi.md#deleteDomain) | **DELETE** /senders/domains/{domainName} | Delete a domain [**getDomainConfiguration**](DomainsApi.md#getDomainConfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration [**getDomains**](DomainsApi.md#getDomains) | **GET** /senders/domains | Get the list of all your domains # **authenticateDomain** > \Brevo\Client\Model\AuthenticateDomainModel authenticateDomain($domainName) Authenticate a domain ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DomainsApi( // 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 ); $domainName = "domainName_example"; // string | Domain name try { $result = $apiInstance->authenticateDomain($domainName); print_r($result); } catch (Exception $e) { echo 'Exception when calling DomainsApi->authenticateDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domainName** | **string**| Domain name | ### Return type [**\Brevo\Client\Model\AuthenticateDomainModel**](../Model/AuthenticateDomainModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createDomain** > \Brevo\Client\Model\CreateDomainModel createDomain($domainName) Create a new domain ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DomainsApi( // 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 ); $domainName = new \Brevo\Client\Model\CreateDomain(); // \Brevo\Client\Model\CreateDomain | domain's name try { $result = $apiInstance->createDomain($domainName); print_r($result); } catch (Exception $e) { echo 'Exception when calling DomainsApi->createDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domainName** | [**\Brevo\Client\Model\CreateDomain**](../Model/CreateDomain.md)| domain's name | [optional] ### Return type [**\Brevo\Client\Model\CreateDomainModel**](../Model/CreateDomainModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteDomain** > deleteDomain($domainName) Delete a domain ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DomainsApi( // 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 ); $domainName = "domainName_example"; // string | Domain name try { $apiInstance->deleteDomain($domainName); } catch (Exception $e) { echo 'Exception when calling DomainsApi->deleteDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domainName** | **string**| Domain name | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getDomainConfiguration** > \Brevo\Client\Model\GetDomainConfigurationModel getDomainConfiguration($domainName) Validate domain configuration ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DomainsApi( // 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 ); $domainName = "domainName_example"; // string | Domain name try { $result = $apiInstance->getDomainConfiguration($domainName); print_r($result); } catch (Exception $e) { echo 'Exception when calling DomainsApi->getDomainConfiguration: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domainName** | **string**| Domain name | ### Return type [**\Brevo\Client\Model\GetDomainConfigurationModel**](../Model/GetDomainConfigurationModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getDomains** > \Brevo\Client\Model\GetDomainsList getDomains() Get the list of all your domains ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DomainsApi( // 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->getDomains(); print_r($result); } catch (Exception $e) { echo 'Exception when calling DomainsApi->getDomains: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetDomainsList**](../Model/GetDomainsList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/TasksApi.md 0000644 00000034455 15021222673 0012163 0 ustar 00 # Brevo\Client\TasksApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**crmTasksGet**](TasksApi.md#crmTasksGet) | **GET** /crm/tasks | Get all tasks [**crmTasksIdDelete**](TasksApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task [**crmTasksIdGet**](TasksApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task [**crmTasksIdPatch**](TasksApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task [**crmTasksPost**](TasksApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task [**crmTasktypesGet**](TasksApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types # **crmTasksGet** > \Brevo\Client\Model\TaskList crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy) Get all tasks ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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 ); $filterType = "filterType_example"; // string | Filter by task type (ID) $filterStatus = "filterStatus_example"; // string | Filter by task status $filterDate = "filterDate_example"; // string | Filter by date $filterAssignTo = "filterAssignTo_example"; // string | Filter by assignTo id $filterContacts = "filterContacts_example"; // string | Filter by contact ids $filterDeals = "filterDeals_example"; // string | Filter by deals ids $filterCompanies = "filterCompanies_example"; // string | Filter by companies ids $dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds) $dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds) $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed $sortBy = "sortBy_example"; // string | The field used to sort field names. try { $result = $apiInstance->crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); print_r($result); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasksGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filterType** | **string**| Filter by task type (ID) | [optional] **filterStatus** | **string**| Filter by task status | [optional] **filterDate** | **string**| Filter by date | [optional] **filterAssignTo** | **string**| Filter by assignTo id | [optional] **filterContacts** | **string**| Filter by contact ids | [optional] **filterDeals** | **string**| Filter by deals ids | [optional] **filterCompanies** | **string**| Filter by companies ids | [optional] **dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] **dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] **sortBy** | **string**| The field used to sort field names. | [optional] ### Return type [**\Brevo\Client\Model\TaskList**](../Model/TaskList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdDelete** > crmTasksIdDelete($id) Delete a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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 ); $id = "id_example"; // string | try { $apiInstance->crmTasksIdDelete($id); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasksIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdGet** > \Brevo\Client\Model\Task crmTasksIdGet($id) Get a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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 ); $id = "id_example"; // string | try { $result = $apiInstance->crmTasksIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasksIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type [**\Brevo\Client\Model\Task**](../Model/Task.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdPatch** > crmTasksIdPatch($id, $body) Update a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body7(); // \Brevo\Client\Model\Body7 | Updated task details. try { $apiInstance->crmTasksIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasksIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body7**](../Model/Body7.md)| Updated task details. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksPost** > \Brevo\Client\Model\InlineResponse2011 crmTasksPost($body) Create a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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 \Brevo\Client\Model\Body6(); // \Brevo\Client\Model\Body6 | Task name. try { $result = $apiInstance->crmTasksPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasksPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body6**](../Model/Body6.md)| Task name. | ### Return type [**\Brevo\Client\Model\InlineResponse2011**](../Model/InlineResponse2011.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasktypesGet** > \Brevo\Client\Model\TaskTypes crmTasktypesGet() Get all task types ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TasksApi( // 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->crmTasktypesGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling TasksApi->crmTasktypesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\TaskTypes**](../Model/TaskTypes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ContactsApi.md 0000644 00000215110 15021222673 0012641 0 ustar 00 # Brevo\Client\ContactsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**addContactToList**](ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list [**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute [**createContact**](ContactsApi.md#createContact) | **POST** /contacts | Create a contact [**createDoiContact**](ContactsApi.md#createDoiContact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow [**createFolder**](ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder [**createList**](ContactsApi.md#createList) | **POST** /contacts/lists | Create a list [**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute [**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{identifier} | Delete a contact [**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) [**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list [**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes [**getContactInfo**](ContactsApi.md#getContactInfo) | **GET** /contacts/{identifier} | Get a contact's details [**getContactStats**](ContactsApi.md#getContactStats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact [**getContacts**](ContactsApi.md#getContacts) | **GET** /contacts | Get all the contacts [**getContactsFromList**](ContactsApi.md#getContactsFromList) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list [**getFolder**](ContactsApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details [**getFolderLists**](ContactsApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder [**getFolders**](ContactsApi.md#getFolders) | **GET** /contacts/folders | Get all folders [**getList**](ContactsApi.md#getList) | **GET** /contacts/lists/{listId} | Get a list's details [**getLists**](ContactsApi.md#getLists) | **GET** /contacts/lists | Get all the lists [**getSegments**](ContactsApi.md#getSegments) | **GET** /contacts/segments | Get all the Segments [**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts [**removeContactFromList**](ContactsApi.md#removeContactFromList) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list [**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts [**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute [**updateBatchContacts**](ContactsApi.md#updateBatchContacts) | **POST** /contacts/batch | Update multiple contacts [**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{identifier} | Update a contact [**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder [**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list # **addContactToList** > \Brevo\Client\Model\PostContactInfo addContactToList($listId, $contactEmails) Add existing contacts to a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list $contactEmails = new \Brevo\Client\Model\AddContactToList(); // \Brevo\Client\Model\AddContactToList | Emails addresses OR IDs of the contacts try { $result = $apiInstance->addContactToList($listId, $contactEmails); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->addContactToList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **contactEmails** | [**\Brevo\Client\Model\AddContactToList**](../Model/AddContactToList.md)| Emails addresses OR IDs of the contacts | ### Return type [**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createAttribute** > createAttribute($attributeCategory, $attributeName, $createAttribute) Create contact attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the attribute $createAttribute = new \Brevo\Client\Model\CreateAttribute(); // \Brevo\Client\Model\CreateAttribute | Values to create an attribute try { $apiInstance->createAttribute($attributeCategory, $attributeName, $createAttribute); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the attribute | **createAttribute** | [**\Brevo\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createContact** > \Brevo\Client\Model\CreateUpdateContactModel createContact($createContact) Create a contact ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $createContact = new \Brevo\Client\Model\CreateContact(); // \Brevo\Client\Model\CreateContact | Values to create a contact try { $result = $apiInstance->createContact($createContact); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createContact** | [**\Brevo\Client\Model\CreateContact**](../Model/CreateContact.md)| Values to create a contact | ### Return type [**\Brevo\Client\Model\CreateUpdateContactModel**](../Model/CreateUpdateContactModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createDoiContact** > createDoiContact($createDoiContact) Create Contact via DOI (Double-Opt-In) Flow ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $createDoiContact = new \Brevo\Client\Model\CreateDoiContact(); // \Brevo\Client\Model\CreateDoiContact | Values to create the Double opt-in (DOI) contact try { $apiInstance->createDoiContact($createDoiContact); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createDoiContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createDoiContact** | [**\Brevo\Client\Model\CreateDoiContact**](../Model/CreateDoiContact.md)| Values to create the Double opt-in (DOI) contact | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createFolder** > \Brevo\Client\Model\CreateModel createFolder($createFolder) Create a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $createFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder try { $result = $apiInstance->createFolder($createFolder); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createList** > \Brevo\Client\Model\CreateModel createList($createList) Create a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $createList = new \Brevo\Client\Model\CreateList(); // \Brevo\Client\Model\CreateList | Values to create a list try { $result = $apiInstance->createList($createList); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createList** | [**\Brevo\Client\Model\CreateList**](../Model/CreateList.md)| Values to create a list | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteAttribute** > deleteAttribute($attributeCategory, $attributeName) Delete an attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the existing attribute try { $apiInstance->deleteAttribute($attributeCategory, $attributeName); } catch (Exception $e) { echo 'Exception when calling ContactsApi->deleteAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the existing attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteContact** > deleteContact($identifier) Delete a contact ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact try { $apiInstance->deleteContact($identifier); } catch (Exception $e) { echo 'Exception when calling ContactsApi->deleteContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **string**| Email (urlencoded) OR ID of the contact | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteFolder** > deleteFolder($folderId) Delete a folder (and all its lists) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $folderId = 789; // int | Id of the folder try { $apiInstance->deleteFolder($folderId); } catch (Exception $e) { echo 'Exception when calling ContactsApi->deleteFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteList** > deleteList($listId) Delete a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list try { $apiInstance->deleteList($listId); } catch (Exception $e) { echo 'Exception when calling ContactsApi->deleteList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAttributes** > \Brevo\Client\Model\GetAttributes getAttributes() List all attributes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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->getAttributes(); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getAttributes: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetAttributes**](../Model/GetAttributes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getContactInfo** > \Brevo\Client\Model\GetExtendedContactDetails getContactInfo($identifier, $startDate, $endDate) Get a contact's details Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.brevo.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact OR its SMS attribute value $startDate = "startDate_example"; // string | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate $endDate = "endDate_example"; // string | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. try { $result = $apiInstance->getContactInfo($identifier, $startDate, $endDate); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContactInfo: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **string**| Email (urlencoded) OR ID of the contact OR its SMS attribute value | **startDate** | **string**| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] **endDate** | **string**| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. | [optional] ### Return type [**\Brevo\Client\Model\GetExtendedContactDetails**](../Model/GetExtendedContactDetails.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getContactStats** > \Brevo\Client\Model\GetContactCampaignStats getContactStats($identifier, $startDate, $endDate) Get email campaigns' statistics for a contact ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days try { $result = $apiInstance->getContactStats($identifier, $startDate, $endDate); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContactStats: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **string**| Email (urlencoded) OR ID of the contact | **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional] ### Return type [**\Brevo\Client\Model\GetContactCampaignStats**](../Model/GetContactCampaignStats.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getContacts** > \Brevo\Client\Model\GetContacts getContacts($limit, $offset, $modifiedSince, $createdSince, $sort) Get all the contacts ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $createdSince = "createdSince_example"; // string | Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getContacts($limit, $offset, $modifiedSince, $createdSince, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **createdSince** | **string**| Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetContacts**](../Model/GetContacts.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getContactsFromList** > \Brevo\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort) Get contacts in a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list $modifiedSince = "modifiedSince_example"; // string | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **modifiedSince** | **string**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetContacts**](../Model/GetContacts.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolder** > \Brevo\Client\Model\GetFolder getFolder($folderId) Returns a folder's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $folderId = 789; // int | id of the folder try { $result = $apiInstance->getFolder($folderId); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| id of the folder | ### Return type [**\Brevo\Client\Model\GetFolder**](../Model/GetFolder.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolderLists** > \Brevo\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort) Get lists in a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $folderId = 789; // int | Id of the folder $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getFolderLists: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetFolderLists**](../Model/GetFolderLists.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolders** > \Brevo\Client\Model\GetFolders getFolders($limit, $offset, $sort) Get all folders ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getFolders($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getFolders: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [default to 10] **offset** | **int**| Index of the first document of the page | [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetFolders**](../Model/GetFolders.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getList** > \Brevo\Client\Model\GetExtendedList getList($listId) Get a list's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list try { $result = $apiInstance->getList($listId); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | ### Return type [**\Brevo\Client\Model\GetExtendedList**](../Model/GetExtendedList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getLists** > \Brevo\Client\Model\GetLists getLists($limit, $offset, $sort) Get all the lists ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getLists($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getLists: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetLists**](../Model/GetLists.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSegments** > \Brevo\Client\Model\GetSegments getSegments($limit, $offset, $sort) Get all the Segments ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getSegments($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getSegments: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [default to 10] **offset** | **int**| Index of the first document of the page | [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetSegments**](../Model/GetSegments.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **importContacts** > \Brevo\Client\Model\CreatedProcessId importContacts($requestContactImport) Import contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $requestContactImport = new \Brevo\Client\Model\RequestContactImport(); // \Brevo\Client\Model\RequestContactImport | Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` try { $result = $apiInstance->importContacts($requestContactImport); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->importContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requestContactImport** | [**\Brevo\Client\Model\RequestContactImport**](../Model/RequestContactImport.md)| Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` | ### Return type [**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **removeContactFromList** > \Brevo\Client\Model\PostContactInfo removeContactFromList($listId, $contactEmails) Delete a contact from a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list $contactEmails = new \Brevo\Client\Model\RemoveContactFromList(); // \Brevo\Client\Model\RemoveContactFromList | Emails addresses OR IDs of the contacts try { $result = $apiInstance->removeContactFromList($listId, $contactEmails); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->removeContactFromList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **contactEmails** | [**\Brevo\Client\Model\RemoveContactFromList**](../Model/RemoveContactFromList.md)| Emails addresses OR IDs of the contacts | ### Return type [**\Brevo\Client\Model\PostContactInfo**](../Model/PostContactInfo.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **requestContactExport** > \Brevo\Client\Model\CreatedProcessId requestContactExport($requestContactExport) Export contacts It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $requestContactExport = new \Brevo\Client\Model\RequestContactExport(); // \Brevo\Client\Model\RequestContactExport | Values to request a contact export try { $result = $apiInstance->requestContactExport($requestContactExport); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->requestContactExport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requestContactExport** | [**\Brevo\Client\Model\RequestContactExport**](../Model/RequestContactExport.md)| Values to request a contact export | ### Return type [**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateAttribute** > updateAttribute($attributeCategory, $attributeName, $updateAttribute) Update contact attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the existing attribute $updateAttribute = new \Brevo\Client\Model\UpdateAttribute(); // \Brevo\Client\Model\UpdateAttribute | Values to update an attribute try { $apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute); } catch (Exception $e) { echo 'Exception when calling ContactsApi->updateAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the existing attribute | **updateAttribute** | [**\Brevo\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateBatchContacts** > updateBatchContacts($updateBatchContacts) Update multiple contacts ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $updateBatchContacts = new \Brevo\Client\Model\UpdateBatchContacts(); // \Brevo\Client\Model\UpdateBatchContacts | Values to update multiple contacts try { $apiInstance->updateBatchContacts($updateBatchContacts); } catch (Exception $e) { echo 'Exception when calling ContactsApi->updateBatchContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **updateBatchContacts** | [**\Brevo\Client\Model\UpdateBatchContacts**](../Model/UpdateBatchContacts.md)| Values to update multiple contacts | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateContact** > updateContact($identifier, $updateContact) Update a contact ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $identifier = "identifier_example"; // string | Email (urlencoded) OR ID of the contact $updateContact = new \Brevo\Client\Model\UpdateContact(); // \Brevo\Client\Model\UpdateContact | Values to update a contact try { $apiInstance->updateContact($identifier, $updateContact); } catch (Exception $e) { echo 'Exception when calling ContactsApi->updateContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **string**| Email (urlencoded) OR ID of the contact | **updateContact** | [**\Brevo\Client\Model\UpdateContact**](../Model/UpdateContact.md)| Values to update a contact | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateFolder** > updateFolder($folderId, $updateFolder) Update a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $folderId = 789; // int | Id of the folder $updateFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder try { $apiInstance->updateFolder($folderId, $updateFolder); } catch (Exception $e) { echo 'Exception when calling ContactsApi->updateFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | **updateFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateList** > updateList($listId, $updateList) Update a list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ContactsApi( // 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 ); $listId = 789; // int | Id of the list $updateList = new \Brevo\Client\Model\UpdateList(); // \Brevo\Client\Model\UpdateList | Values to update a list try { $apiInstance->updateList($listId, $updateList); } catch (Exception $e) { echo 'Exception when calling ContactsApi->updateList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | **updateList** | [**\Brevo\Client\Model\UpdateList**](../Model/UpdateList.md)| Values to update a list | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/AttributesApi.md 0000644 00000022644 15021222673 0013221 0 ustar 00 # Brevo\Client\AttributesApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute [**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute [**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | List all attributes [**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute # **createAttribute** > createAttribute($attributeCategory, $attributeName, $createAttribute) Create contact attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AttributesApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the attribute $createAttribute = new \Brevo\Client\Model\CreateAttribute(); // \Brevo\Client\Model\CreateAttribute | Values to create an attribute try { $apiInstance->createAttribute($attributeCategory, $attributeName, $createAttribute); } catch (Exception $e) { echo 'Exception when calling AttributesApi->createAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the attribute | **createAttribute** | [**\Brevo\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteAttribute** > deleteAttribute($attributeCategory, $attributeName) Delete an attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AttributesApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the existing attribute try { $apiInstance->deleteAttribute($attributeCategory, $attributeName); } catch (Exception $e) { echo 'Exception when calling AttributesApi->deleteAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the existing attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAttributes** > \Brevo\Client\Model\GetAttributes getAttributes() List all attributes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AttributesApi( // 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->getAttributes(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AttributesApi->getAttributes: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetAttributes**](../Model/GetAttributes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateAttribute** > updateAttribute($attributeCategory, $attributeName, $updateAttribute) Update contact attribute ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AttributesApi( // 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 ); $attributeCategory = "attributeCategory_example"; // string | Category of the attribute $attributeName = "attributeName_example"; // string | Name of the existing attribute $updateAttribute = new \Brevo\Client\Model\UpdateAttribute(); // \Brevo\Client\Model\UpdateAttribute | Values to update an attribute try { $apiInstance->updateAttribute($attributeCategory, $attributeName, $updateAttribute); } catch (Exception $e) { echo 'Exception when calling AttributesApi->updateAttribute: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attributeCategory** | **string**| Category of the attribute | **attributeName** | **string**| Name of the existing attribute | **updateAttribute** | [**\Brevo\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/CompaniesApi.md 0000644 00000040071 15021222673 0013003 0 ustar 00 # Brevo\Client\CompaniesApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**companiesAttributesGet**](CompaniesApi.md#companiesAttributesGet) | **GET** /companies/attributes | Get company attributes [**companiesGet**](CompaniesApi.md#companiesGet) | **GET** /companies | Get all companies [**companiesIdDelete**](CompaniesApi.md#companiesIdDelete) | **DELETE** /companies/{id} | Delete a company [**companiesIdGet**](CompaniesApi.md#companiesIdGet) | **GET** /companies/{id} | Get a company [**companiesIdPatch**](CompaniesApi.md#companiesIdPatch) | **PATCH** /companies/{id} | Update a company [**companiesLinkUnlinkIdPatch**](CompaniesApi.md#companiesLinkUnlinkIdPatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals [**companiesPost**](CompaniesApi.md#companiesPost) | **POST** /companies | Create a company # **companiesAttributesGet** > \Brevo\Client\Model\CompanyAttributes companiesAttributesGet() Get company attributes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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->companiesAttributesGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesAttributesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\CompanyAttributes**](../Model/CompanyAttributes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesGet** > \Brevo\Client\Model\CompaniesList companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy) Get all companies ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 ); $filters = "filters_example"; // string | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} $linkedContactsIds = 789; // int | Filter by linked contacts ids $linkedDealsIds = "linkedDealsIds_example"; // string | Filter by linked deals ids $page = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed $sortBy = "sortBy_example"; // string | The field used to sort field names. try { $result = $apiInstance->companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy); print_r($result); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filters** | **string**| Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} | [optional] **linkedContactsIds** | **int**| Filter by linked contacts ids | [optional] **linkedDealsIds** | **string**| Filter by linked deals ids | [optional] **page** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] **sortBy** | **string**| The field used to sort field names. | [optional] ### Return type [**\Brevo\Client\Model\CompaniesList**](../Model/CompaniesList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesIdDelete** > companiesIdDelete($id) Delete a company ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 ); $id = "id_example"; // string | try { $apiInstance->companiesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesIdGet** > \Brevo\Client\Model\Company companiesIdGet($id) Get a company ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 ); $id = "id_example"; // string | try { $result = $apiInstance->companiesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type [**\Brevo\Client\Model\Company**](../Model/Company.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesIdPatch** > \Brevo\Client\Model\Company companiesIdPatch($id, $body) Update a company ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body1(); // \Brevo\Client\Model\Body1 | Updated company details. try { $result = $apiInstance->companiesIdPatch($id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body1**](../Model/Body1.md)| Updated company details. | ### Return type [**\Brevo\Client\Model\Company**](../Model/Company.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesLinkUnlinkIdPatch** > companiesLinkUnlinkIdPatch($id, $body) Link and Unlink company with contacts and deals ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body2(); // \Brevo\Client\Model\Body2 | Linked / Unlinked contacts and deals ids. try { $apiInstance->companiesLinkUnlinkIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesLinkUnlinkIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body2**](../Model/Body2.md)| Linked / Unlinked contacts and deals ids. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **companiesPost** > \Brevo\Client\Model\InlineResponse200 companiesPost($body) Create a company ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CompaniesApi( // 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 \Brevo\Client\Model\Body(); // \Brevo\Client\Model\Body | Company create data. try { $result = $apiInstance->companiesPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling CompaniesApi->companiesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body**](../Model/Body.md)| Company create data. | ### Return type [**\Brevo\Client\Model\InlineResponse200**](../Model/InlineResponse200.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/CRMApi.md 0000644 00000063122 15021222673 0011510 0 ustar 00 # Brevo\Client\CRMApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**crmNotesGet**](CRMApi.md#crmNotesGet) | **GET** /crm/notes | Get all notes [**crmNotesIdDelete**](CRMApi.md#crmNotesIdDelete) | **DELETE** /crm/notes/{id} | Delete a note [**crmNotesIdGet**](CRMApi.md#crmNotesIdGet) | **GET** /crm/notes/{id} | Get a note [**crmNotesIdPatch**](CRMApi.md#crmNotesIdPatch) | **PATCH** /crm/notes/{id} | Update a note [**crmNotesPost**](CRMApi.md#crmNotesPost) | **POST** /crm/notes | Create a note [**crmTasksGet**](CRMApi.md#crmTasksGet) | **GET** /crm/tasks | Get all tasks [**crmTasksIdDelete**](CRMApi.md#crmTasksIdDelete) | **DELETE** /crm/tasks/{id} | Delete a task [**crmTasksIdGet**](CRMApi.md#crmTasksIdGet) | **GET** /crm/tasks/{id} | Get a task [**crmTasksIdPatch**](CRMApi.md#crmTasksIdPatch) | **PATCH** /crm/tasks/{id} | Update a task [**crmTasksPost**](CRMApi.md#crmTasksPost) | **POST** /crm/tasks | Create a task [**crmTasktypesGet**](CRMApi.md#crmTasktypesGet) | **GET** /crm/tasktypes | Get all task types # **crmNotesGet** > \Brevo\Client\Model\NoteList crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) Get all notes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $entity = "entity_example"; // string | Filter by note entity type $entityIds = "entityIds_example"; // string | Filter by note entity IDs $dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds) $dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds) $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed try { $result = $apiInstance->crmNotesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmNotesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entity** | **string**| Filter by note entity type | [optional] **entityIds** | **string**| Filter by note entity IDs | [optional] **dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] **dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] ### Return type [**\Brevo\Client\Model\NoteList**](../Model/NoteList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdDelete** > crmNotesIdDelete($id) Delete a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | Note ID to delete try { $apiInstance->crmNotesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmNotesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to delete | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdGet** > \Brevo\Client\Model\Note crmNotesIdGet($id) Get a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | Note ID to get try { $result = $apiInstance->crmNotesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmNotesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to get | ### Return type [**\Brevo\Client\Model\Note**](../Model/Note.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesIdPatch** > crmNotesIdPatch($id, $body) Update a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | Note ID to update $body = new \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to update a note try { $apiInstance->crmNotesIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmNotesIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Note ID to update | **body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to update a note | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmNotesPost** > \Brevo\Client\Model\NoteId crmNotesPost($body) Create a note ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 \Brevo\Client\Model\NoteData(); // \Brevo\Client\Model\NoteData | Note data to create a note. try { $result = $apiInstance->crmNotesPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmNotesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\NoteData**](../Model/NoteData.md)| Note data to create a note. | ### Return type [**\Brevo\Client\Model\NoteId**](../Model/NoteId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksGet** > \Brevo\Client\Model\TaskList crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy) Get all tasks ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $filterType = "filterType_example"; // string | Filter by task type (ID) $filterStatus = "filterStatus_example"; // string | Filter by task status $filterDate = "filterDate_example"; // string | Filter by date $filterAssignTo = "filterAssignTo_example"; // string | Filter by assignTo id $filterContacts = "filterContacts_example"; // string | Filter by contact ids $filterDeals = "filterDeals_example"; // string | Filter by deals ids $filterCompanies = "filterCompanies_example"; // string | Filter by companies ids $dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds) $dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds) $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed $sortBy = "sortBy_example"; // string | The field used to sort field names. try { $result = $apiInstance->crmTasksGet($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasksGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filterType** | **string**| Filter by task type (ID) | [optional] **filterStatus** | **string**| Filter by task status | [optional] **filterDate** | **string**| Filter by date | [optional] **filterAssignTo** | **string**| Filter by assignTo id | [optional] **filterContacts** | **string**| Filter by contact ids | [optional] **filterDeals** | **string**| Filter by deals ids | [optional] **filterCompanies** | **string**| Filter by companies ids | [optional] **dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] **dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] **sortBy** | **string**| The field used to sort field names. | [optional] ### Return type [**\Brevo\Client\Model\TaskList**](../Model/TaskList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdDelete** > crmTasksIdDelete($id) Delete a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | try { $apiInstance->crmTasksIdDelete($id); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasksIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdGet** > \Brevo\Client\Model\Task crmTasksIdGet($id) Get a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | try { $result = $apiInstance->crmTasksIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasksIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type [**\Brevo\Client\Model\Task**](../Model/Task.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksIdPatch** > crmTasksIdPatch($id, $body) Update a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body1(); // \Brevo\Client\Model\Body1 | Updated task details. try { $apiInstance->crmTasksIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasksIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body1**](../Model/Body1.md)| Updated task details. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasksPost** > \Brevo\Client\Model\InlineResponse201 crmTasksPost($body) Create a task ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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 \Brevo\Client\Model\Body(); // \Brevo\Client\Model\Body | Task name. try { $result = $apiInstance->crmTasksPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasksPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body**](../Model/Body.md)| Task name. | ### Return type [**\Brevo\Client\Model\InlineResponse201**](../Model/InlineResponse201.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmTasktypesGet** > \Brevo\Client\Model\TaskTypes crmTasktypesGet() Get all task types ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CRMApi( // 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->crmTasktypesGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling CRMApi->crmTasktypesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\TaskTypes**](../Model/TaskTypes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/FilesApi.md 0000644 00000027623 15021222673 0012137 0 ustar 00 # Brevo\Client\FilesApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**crmFilesGet**](FilesApi.md#crmFilesGet) | **GET** /crm/files | Get all files [**crmFilesIdDataGet**](FilesApi.md#crmFilesIdDataGet) | **GET** /crm/files/{id}/data | Get file details [**crmFilesIdDelete**](FilesApi.md#crmFilesIdDelete) | **DELETE** /crm/files/{id} | Delete a file [**crmFilesIdGet**](FilesApi.md#crmFilesIdGet) | **GET** /crm/files/{id} | Download a file [**crmFilesPost**](FilesApi.md#crmFilesPost) | **POST** /crm/files | Upload a file # **crmFilesGet** > \Brevo\Client\Model\FileList crmFilesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) Get all files ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FilesApi( // 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 ); $entity = "entity_example"; // string | Filter by file entity type $entityIds = "entityIds_example"; // string | Filter by file entity IDs $dateFrom = 56; // int | dateFrom to date range filter type (timestamp in milliseconds) $dateTo = 56; // int | dateTo to date range filter type (timestamp in milliseconds) $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed try { $result = $apiInstance->crmFilesGet($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling FilesApi->crmFilesGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entity** | **string**| Filter by file entity type | [optional] **entityIds** | **string**| Filter by file entity IDs | [optional] **dateFrom** | **int**| dateFrom to date range filter type (timestamp in milliseconds) | [optional] **dateTo** | **int**| dateTo to date range filter type (timestamp in milliseconds) | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] ### Return type [**\Brevo\Client\Model\FileList**](../Model/FileList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmFilesIdDataGet** > \Brevo\Client\Model\FileData crmFilesIdDataGet($id) Get file details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FilesApi( // 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 ); $id = "id_example"; // string | File id to get file data. try { $result = $apiInstance->crmFilesIdDataGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling FilesApi->crmFilesIdDataGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| File id to get file data. | ### Return type [**\Brevo\Client\Model\FileData**](../Model/FileData.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmFilesIdDelete** > crmFilesIdDelete($id) Delete a file ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FilesApi( // 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 ); $id = "id_example"; // string | File id to delete. try { $apiInstance->crmFilesIdDelete($id); } catch (Exception $e) { echo 'Exception when calling FilesApi->crmFilesIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| File id to delete. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmFilesIdGet** > \Brevo\Client\Model\FileDownloadableLink crmFilesIdGet($id) Download a file ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FilesApi( // 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 ); $id = "id_example"; // string | File id to download. try { $result = $apiInstance->crmFilesIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling FilesApi->crmFilesIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| File id to download. | ### Return type [**\Brevo\Client\Model\FileDownloadableLink**](../Model/FileDownloadableLink.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmFilesPost** > \Brevo\Client\Model\FileData crmFilesPost($file, $dealId, $contactId, $companyId) Upload a file ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FilesApi( // 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 ); $file = "/path/to/file.txt"; // \SplFileObject | File data to create a file. $dealId = "dealId_example"; // string | Deal id linked to a file $contactId = 789; // int | Contact id linked to a file $companyId = "companyId_example"; // string | Company id linked to a file try { $result = $apiInstance->crmFilesPost($file, $dealId, $contactId, $companyId); print_r($result); } catch (Exception $e) { echo 'Exception when calling FilesApi->crmFilesPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file** | **\SplFileObject**| File data to create a file. | **dealId** | **string**| Deal id linked to a file | [optional] **contactId** | **int**| Contact id linked to a file | [optional] **companyId** | **string**| Company id linked to a file | [optional] ### Return type [**\Brevo\Client\Model\FileData**](../Model/FileData.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: multipart/form-data - **Accept**: application/json [[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) brevo-php/docs/Api/UserApi.md 0000644 00000010356 15021222673 0012006 0 ustar 00 # Brevo\Client\UserApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getInvitedUsersList**](UserApi.md#getInvitedUsersList) | **GET** /organization/invited/users | Get the list of all your users [**getUserPermission**](UserApi.md#getUserPermission) | **GET** /organization/user/{email}/permissions | Check user permission # **getInvitedUsersList** > \Brevo\Client\Model\GetInvitedUsersList getInvitedUsersList() Get the list of all your users ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\UserApi( // 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->getInvitedUsersList(); print_r($result); } catch (Exception $e) { echo 'Exception when calling UserApi->getInvitedUsersList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetInvitedUsersList**](../Model/GetInvitedUsersList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getUserPermission** > \Brevo\Client\Model\GetUserPermission getUserPermission($email) Check user permission ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\UserApi( // 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 ); $email = "email_example"; // string | Email of the invited user. try { $result = $apiInstance->getUserPermission($email); print_r($result); } catch (Exception $e) { echo 'Exception when calling UserApi->getUserPermission: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **string**| Email of the invited user. | ### Return type [**\Brevo\Client\Model\GetUserPermission**](../Model/GetUserPermission.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/DealsApi.md 0000644 00000054065 15021222673 0012125 0 ustar 00 # Brevo\Client\DealsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**crmAttributesDealsGet**](DealsApi.md#crmAttributesDealsGet) | **GET** /crm/attributes/deals | Get deal attributes [**crmDealsGet**](DealsApi.md#crmDealsGet) | **GET** /crm/deals | Get all deals [**crmDealsIdDelete**](DealsApi.md#crmDealsIdDelete) | **DELETE** /crm/deals/{id} | Delete a deal [**crmDealsIdGet**](DealsApi.md#crmDealsIdGet) | **GET** /crm/deals/{id} | Get a deal [**crmDealsIdPatch**](DealsApi.md#crmDealsIdPatch) | **PATCH** /crm/deals/{id} | Update a deal [**crmDealsLinkUnlinkIdPatch**](DealsApi.md#crmDealsLinkUnlinkIdPatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies [**crmDealsPost**](DealsApi.md#crmDealsPost) | **POST** /crm/deals | Create a deal [**crmPipelineDetailsAllGet**](DealsApi.md#crmPipelineDetailsAllGet) | **GET** /crm/pipeline/details/all | Get all pipelines [**crmPipelineDetailsGet**](DealsApi.md#crmPipelineDetailsGet) | **GET** /crm/pipeline/details | Get pipeline stages [**crmPipelineDetailsPipelineIDGet**](DealsApi.md#crmPipelineDetailsPipelineIDGet) | **GET** /crm/pipeline/details/{pipelineID} | Get a pipeline # **crmAttributesDealsGet** > \Brevo\Client\Model\DealAttributes crmAttributesDealsGet() Get deal attributes ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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->crmAttributesDealsGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmAttributesDealsGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\DealAttributes**](../Model/DealAttributes.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsGet** > \Brevo\Client\Model\DealsList crmDealsGet($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy) Get all deals ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $filtersAttributesDealName = "filtersAttributesDealName_example"; // string | Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" $filtersLinkedCompaniesIds = "filtersLinkedCompaniesIds_example"; // string | Filter by linked companies ids $filtersLinkedContactsIds = "filtersLinkedContactsIds_example"; // string | Filter by linked companies ids $offset = 789; // int | Index of the first document of the page $limit = 50; // int | Number of documents per page $sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed $sortBy = "sortBy_example"; // string | The field used to sort field names. try { $result = $apiInstance->crmDealsGet($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filtersAttributesDealName** | **string**| Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" | [optional] **filtersLinkedCompaniesIds** | **string**| Filter by linked companies ids | [optional] **filtersLinkedContactsIds** | **string**| Filter by linked companies ids | [optional] **offset** | **int**| Index of the first document of the page | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] **sortBy** | **string**| The field used to sort field names. | [optional] ### Return type [**\Brevo\Client\Model\DealsList**](../Model/DealsList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsIdDelete** > crmDealsIdDelete($id) Delete a deal ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $id = "id_example"; // string | try { $apiInstance->crmDealsIdDelete($id); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsIdGet** > \Brevo\Client\Model\Deal crmDealsIdGet($id) Get a deal ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $id = "id_example"; // string | try { $result = $apiInstance->crmDealsIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | ### Return type [**\Brevo\Client\Model\Deal**](../Model/Deal.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsIdPatch** > crmDealsIdPatch($id, $body) Update a deal ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body4(); // \Brevo\Client\Model\Body4 | Updated deal details. try { $apiInstance->crmDealsIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body4**](../Model/Body4.md)| Updated deal details. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsLinkUnlinkIdPatch** > crmDealsLinkUnlinkIdPatch($id, $body) Link and Unlink a deal with contacts and companies ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $id = "id_example"; // string | $body = new \Brevo\Client\Model\Body5(); // \Brevo\Client\Model\Body5 | Linked / Unlinked contacts and companies ids. try { $apiInstance->crmDealsLinkUnlinkIdPatch($id, $body); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsLinkUnlinkIdPatch: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| | **body** | [**\Brevo\Client\Model\Body5**](../Model/Body5.md)| Linked / Unlinked contacts and companies ids. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmDealsPost** > \Brevo\Client\Model\InlineResponse201 crmDealsPost($body) Create a deal ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 \Brevo\Client\Model\Body3(); // \Brevo\Client\Model\Body3 | Deal create data. try { $result = $apiInstance->crmDealsPost($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmDealsPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\Brevo\Client\Model\Body3**](../Model/Body3.md)| Deal create data. | ### Return type [**\Brevo\Client\Model\InlineResponse201**](../Model/InlineResponse201.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmPipelineDetailsAllGet** > \Brevo\Client\Model\Pipelines crmPipelineDetailsAllGet() Get all pipelines ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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->crmPipelineDetailsAllGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmPipelineDetailsAllGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\Pipelines**](../Model/Pipelines.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmPipelineDetailsGet** > \Brevo\Client\Model\Pipeline crmPipelineDetailsGet() Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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->crmPipelineDetailsGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmPipelineDetailsGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\Pipeline**](../Model/Pipeline.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **crmPipelineDetailsPipelineIDGet** > \Brevo\Client\Model\Pipelines crmPipelineDetailsPipelineIDGet($pipelineID) Get a pipeline ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\DealsApi( // 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 ); $pipelineID = "pipelineID_example"; // string | try { $result = $apiInstance->crmPipelineDetailsPipelineIDGet($pipelineID); print_r($result); } catch (Exception $e) { echo 'Exception when calling DealsApi->crmPipelineDetailsPipelineIDGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pipelineID** | **string**| | ### Return type [**\Brevo\Client\Model\Pipelines**](../Model/Pipelines.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/SendersApi.md 0000644 00000035531 15021222673 0012475 0 ustar 00 # Brevo\Client\SendersApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createSender**](SendersApi.md#createSender) | **POST** /senders | Create a new sender [**deleteSender**](SendersApi.md#deleteSender) | **DELETE** /senders/{senderId} | Delete a sender [**getIps**](SendersApi.md#getIps) | **GET** /senders/ips | Get all the dedicated IPs for your account [**getIpsFromSender**](SendersApi.md#getIpsFromSender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender [**getSenders**](SendersApi.md#getSenders) | **GET** /senders | Get the list of all your senders [**updateSender**](SendersApi.md#updateSender) | **PUT** /senders/{senderId} | Update a sender [**validateSenderByOTP**](SendersApi.md#validateSenderByOTP) | **PUT** /senders/{senderId}/validate | Update a sender # **createSender** > \Brevo\Client\Model\CreateSenderModel createSender($sender) Create a new sender ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $sender = new \Brevo\Client\Model\CreateSender(); // \Brevo\Client\Model\CreateSender | sender's name try { $result = $apiInstance->createSender($sender); print_r($result); } catch (Exception $e) { echo 'Exception when calling SendersApi->createSender: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sender** | [**\Brevo\Client\Model\CreateSender**](../Model/CreateSender.md)| sender's name | [optional] ### Return type [**\Brevo\Client\Model\CreateSenderModel**](../Model/CreateSenderModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteSender** > deleteSender($senderId) Delete a sender ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $senderId = 789; // int | Id of the sender try { $apiInstance->deleteSender($senderId); } catch (Exception $e) { echo 'Exception when calling SendersApi->deleteSender: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **senderId** | **int**| Id of the sender | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getIps** > \Brevo\Client\Model\GetIps getIps() Get all the dedicated IPs for your account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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->getIps(); print_r($result); } catch (Exception $e) { echo 'Exception when calling SendersApi->getIps: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetIps**](../Model/GetIps.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getIpsFromSender** > \Brevo\Client\Model\GetIpsFromSender getIpsFromSender($senderId) Get all the dedicated IPs for a sender ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $senderId = 789; // int | Id of the sender try { $result = $apiInstance->getIpsFromSender($senderId); print_r($result); } catch (Exception $e) { echo 'Exception when calling SendersApi->getIpsFromSender: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **senderId** | **int**| Id of the sender | ### Return type [**\Brevo\Client\Model\GetIpsFromSender**](../Model/GetIpsFromSender.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSenders** > \Brevo\Client\Model\GetSendersList getSenders($ip, $domain) Get the list of all your senders ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $ip = "ip_example"; // string | Filter your senders for a specific ip (available for dedicated IP usage only) $domain = "domain_example"; // string | Filter your senders for a specific domain try { $result = $apiInstance->getSenders($ip, $domain); print_r($result); } catch (Exception $e) { echo 'Exception when calling SendersApi->getSenders: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ip** | **string**| Filter your senders for a specific ip (available for dedicated IP usage only) | [optional] **domain** | **string**| Filter your senders for a specific domain | [optional] ### Return type [**\Brevo\Client\Model\GetSendersList**](../Model/GetSendersList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateSender** > updateSender($senderId, $sender) Update a sender ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $senderId = 789; // int | Id of the sender $sender = new \Brevo\Client\Model\UpdateSender(); // \Brevo\Client\Model\UpdateSender | sender's name try { $apiInstance->updateSender($senderId, $sender); } catch (Exception $e) { echo 'Exception when calling SendersApi->updateSender: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **senderId** | **int**| Id of the sender | **sender** | [**\Brevo\Client\Model\UpdateSender**](../Model/UpdateSender.md)| sender's name | [optional] ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **validateSenderByOTP** > validateSenderByOTP($senderId, $otp) Update a sender ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SendersApi( // 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 ); $senderId = 789; // int | Id of the sender $otp = new \Brevo\Client\Model\Otp(); // \Brevo\Client\Model\Otp | otp try { $apiInstance->validateSenderByOTP($senderId, $otp); } catch (Exception $e) { echo 'Exception when calling SendersApi->validateSenderByOTP: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **senderId** | **int**| Id of the sender | **otp** | [**\Brevo\Client\Model\Otp**](../Model/Otp.md)| otp | [optional] ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/TransactionalSMSApi.md 0000644 00000031660 15021222673 0014256 0 ustar 00 # Brevo\Client\TransactionalSMSApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getSmsEvents**](TransactionalSMSApi.md#getSmsEvents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) [**getTransacAggregatedSmsReport**](TransactionalSMSApi.md#getTransacAggregatedSmsReport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time [**getTransacSmsReport**](TransactionalSMSApi.md#getTransacSmsReport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day [**sendTransacSms**](TransactionalSMSApi.md#sendTransacSms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number # **getSmsEvents** > \Brevo\Client\Model\GetSmsEventReport getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort) Get all your SMS activity (unaggregated events) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalSMSApi( // 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 ); $limit = 50; // int | Number of documents per page $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report $offset = 0; // int | Index of the first document of the page $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' $phoneNumber = "phoneNumber_example"; // string | Filter the report for a specific phone number $event = "event_example"; // string | Filter the report for specific events $tags = "tags_example"; // string | Filter the report for specific tags passed as a serialized urlencoded array $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalSMSApi->getSmsEvents: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 50] **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **phoneNumber** | **string**| Filter the report for a specific phone number | [optional] **event** | **string**| Filter the report for specific events | [optional] **tags** | **string**| Filter the report for specific tags passed as a serialized urlencoded array | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetSmsEventReport**](../Model/GetSmsEventReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getTransacAggregatedSmsReport** > \Brevo\Client\Model\GetTransacAggregatedSmsReport getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag) Get your SMS activity aggregated over a period of time ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalSMSApi( // 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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate $tag = "tag_example"; // string | Filter on a tag try { $result = $apiInstance->getTransacAggregatedSmsReport($startDate, $endDate, $days, $tag); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalSMSApi->getTransacAggregatedSmsReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional] **tag** | **string**| Filter on a tag | [optional] ### Return type [**\Brevo\Client\Model\GetTransacAggregatedSmsReport**](../Model/GetTransacAggregatedSmsReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getTransacSmsReport** > \Brevo\Client\Model\GetTransacSmsReport getTransacSmsReport($startDate, $endDate, $days, $tag, $sort) Get your SMS activity aggregated per day ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalSMSApi( // 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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' $tag = "tag_example"; // string | Filter on a tag $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getTransacSmsReport($startDate, $endDate, $days, $tag, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalSMSApi->getTransacSmsReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **tag** | **string**| Filter on a tag | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetTransacSmsReport**](../Model/GetTransacSmsReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendTransacSms** > \Brevo\Client\Model\SendSms sendTransacSms($sendTransacSms) Send SMS message to a mobile number ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalSMSApi( // 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 ); $sendTransacSms = new \Brevo\Client\Model\SendTransacSms(); // \Brevo\Client\Model\SendTransacSms | Values to send a transactional SMS try { $result = $apiInstance->sendTransacSms($sendTransacSms); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalSMSApi->sendTransacSms: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sendTransacSms** | [**\Brevo\Client\Model\SendTransacSms**](../Model/SendTransacSms.md)| Values to send a transactional SMS | ### Return type [**\Brevo\Client\Model\SendSms**](../Model/SendSms.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/EmailCampaignsApi.md 0000644 00000101611 15021222673 0013735 0 ustar 00 # Brevo\Client\EmailCampaignsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign [**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign [**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign [**getAbTestCampaignResult**](EmailCampaignsApi.md#getAbTestCampaignResult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results [**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report [**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created email campaigns [**getSharedTemplateUrl**](EmailCampaignsApi.md#getSharedTemplateUrl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url [**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId [**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign [**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list [**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status [**updateEmailCampaign**](EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign [**uploadImageToGallery**](EmailCampaignsApi.md#uploadImageToGallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery # **createEmailCampaign** > \Brevo\Client\Model\CreateModel createEmailCampaign($emailCampaigns) Create an email campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $emailCampaigns = new \Brevo\Client\Model\CreateEmailCampaign(); // \Brevo\Client\Model\CreateEmailCampaign | Values to create a campaign try { $result = $apiInstance->createEmailCampaign($emailCampaigns); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->createEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **emailCampaigns** | [**\Brevo\Client\Model\CreateEmailCampaign**](../Model/CreateEmailCampaign.md)| Values to create a campaign | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteEmailCampaign** > deleteEmailCampaign($campaignId) Delete an email campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign try { $apiInstance->deleteEmailCampaign($campaignId); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->deleteEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **emailExportRecipients** > \Brevo\Client\Model\CreatedProcessId emailExportRecipients($campaignId, $recipientExport) Export the recipients of an email campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $recipientExport = new \Brevo\Client\Model\EmailExportRecipients(); // \Brevo\Client\Model\EmailExportRecipients | Values to send for a recipient export request try { $result = $apiInstance->emailExportRecipients($campaignId, $recipientExport); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->emailExportRecipients: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **recipientExport** | [**\Brevo\Client\Model\EmailExportRecipients**](../Model/EmailExportRecipients.md)| Values to send for a recipient export request | [optional] ### Return type [**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAbTestCampaignResult** > \Brevo\Client\Model\AbTestCampaignResult getAbTestCampaignResult($campaignId) Get an A/B test email campaign results Obtain winning version of an A/B test email campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the A/B test campaign try { $result = $apiInstance->getAbTestCampaignResult($campaignId); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->getAbTestCampaignResult: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the A/B test campaign | ### Return type [**\Brevo\Client\Model\AbTestCampaignResult**](../Model/AbTestCampaignResult.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getEmailCampaign** > \Brevo\Client\Model\GetEmailCampaign getEmailCampaign($campaignId, $statistics) Get an email campaign report ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $statistics = "statistics_example"; // string | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. try { $result = $apiInstance->getEmailCampaign($campaignId, $statistics); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->getEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **statistics** | **string**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional] ### Return type [**\Brevo\Client\Model\GetEmailCampaign**](../Model/GetEmailCampaign.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getEmailCampaigns** > \Brevo\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent) Return all your created email campaigns ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $type = "type_example"; // string | Filter on the type of the campaigns $status = "status_example"; // string | Filter on the status of the campaign $statistics = "statistics_example"; // string | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed $excludeHtmlContent = true; // bool | Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body try { $result = $apiInstance->getEmailCampaigns($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **type** | **string**| Filter on the type of the campaigns | [optional] **status** | **string**| Filter on the status of the campaign | [optional] **statistics** | **string**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional] **startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] **excludeHtmlContent** | **bool**| Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body | [optional] ### Return type [**\Brevo\Client\Model\GetEmailCampaigns**](../Model/GetEmailCampaigns.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSharedTemplateUrl** > \Brevo\Client\Model\GetSharedTemplateUrl getSharedTemplateUrl($campaignId) Get a shared template url Get a unique URL to share & import an email template from one Brevo account to another. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign or template try { $result = $apiInstance->getSharedTemplateUrl($campaignId); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->getSharedTemplateUrl: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign or template | ### Return type [**\Brevo\Client\Model\GetSharedTemplateUrl**](../Model/GetSharedTemplateUrl.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendEmailCampaignNow** > sendEmailCampaignNow($campaignId) Send an email campaign immediately, based on campaignId ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign try { $apiInstance->sendEmailCampaignNow($campaignId); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->sendEmailCampaignNow: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendReport** > sendReport($campaignId, $sendReport) Send the report of a campaign A PDF will be sent to the specified email addresses ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $sendReport = new \Brevo\Client\Model\SendReport(); // \Brevo\Client\Model\SendReport | Values for send a report try { $apiInstance->sendReport($campaignId, $sendReport); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->sendReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **sendReport** | [**\Brevo\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendTestEmail** > sendTestEmail($campaignId, $emailTo) Send an email campaign to your test list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $emailTo = new \Brevo\Client\Model\SendTestEmail(); // \Brevo\Client\Model\SendTestEmail | try { $apiInstance->sendTestEmail($campaignId, $emailTo); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->sendTestEmail: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **emailTo** | [**\Brevo\Client\Model\SendTestEmail**](../Model/SendTestEmail.md)| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateCampaignStatus** > updateCampaignStatus($campaignId, $status) Update an email campaign status ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $status = new \Brevo\Client\Model\UpdateCampaignStatus(); // \Brevo\Client\Model\UpdateCampaignStatus | Status of the campaign try { $apiInstance->updateCampaignStatus($campaignId, $status); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->updateCampaignStatus: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **status** | [**\Brevo\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateEmailCampaign** > updateEmailCampaign($campaignId, $emailCampaign) Update an email campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the campaign $emailCampaign = new \Brevo\Client\Model\UpdateEmailCampaign(); // \Brevo\Client\Model\UpdateEmailCampaign | Values to update a campaign try { $apiInstance->updateEmailCampaign($campaignId, $emailCampaign); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->updateEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the campaign | **emailCampaign** | [**\Brevo\Client\Model\UpdateEmailCampaign**](../Model/UpdateEmailCampaign.md)| Values to update a campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **uploadImageToGallery** > \Brevo\Client\Model\UploadImageModel uploadImageToGallery($uploadImage) Upload an image to your account's image gallery ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\EmailCampaignsApi( // 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 ); $uploadImage = new \Brevo\Client\Model\UploadImageToGallery(); // \Brevo\Client\Model\UploadImageToGallery | Parameters to upload an image try { $result = $apiInstance->uploadImageToGallery($uploadImage); print_r($result); } catch (Exception $e) { echo 'Exception when calling EmailCampaignsApi->uploadImageToGallery: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uploadImage** | [**\Brevo\Client\Model\UploadImageToGallery**](../Model/UploadImageToGallery.md)| Parameters to upload an image | ### Return type [**\Brevo\Client\Model\UploadImageModel**](../Model/UploadImageModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/MasterAccountApi.md 0000644 00000062540 15021222673 0013642 0 ustar 00 # Brevo\Client\MasterAccountApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**corporateMasterAccountGet**](MasterAccountApi.md#corporateMasterAccountGet) | **GET** /corporate/masterAccount | Get the details of requested master account [**corporateSubAccountGet**](MasterAccountApi.md#corporateSubAccountGet) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account. [**corporateSubAccountIdApplicationsTogglePut**](MasterAccountApi.md#corporateSubAccountIdApplicationsTogglePut) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s) [**corporateSubAccountIdDelete**](MasterAccountApi.md#corporateSubAccountIdDelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account [**corporateSubAccountIdGet**](MasterAccountApi.md#corporateSubAccountIdGet) | **GET** /corporate/subAccount/{id} | Get sub-account details [**corporateSubAccountIdPlanPut**](MasterAccountApi.md#corporateSubAccountIdPlanPut) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan [**corporateSubAccountKeyPost**](MasterAccountApi.md#corporateSubAccountKeyPost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account [**corporateSubAccountPost**](MasterAccountApi.md#corporateSubAccountPost) | **POST** /corporate/subAccount | Create a new sub-account under a master account. [**corporateSubAccountSsoTokenPost**](MasterAccountApi.md#corporateSubAccountSsoTokenPost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo [**getAccountActivity**](MasterAccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs # **corporateMasterAccountGet** > \Brevo\Client\Model\MasterDetailsResponse corporateMasterAccountGet() Get the details of requested master account This endpoint will provide the details of the master account. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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->corporateMasterAccountGet(); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateMasterAccountGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\MasterDetailsResponse**](../Model/MasterDetailsResponse.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountGet** > \Brevo\Client\Model\SubAccountsResponse corporateSubAccountGet($offset, $limit) Get the list of all the sub-accounts of the master account. This endpoint will provide the list all the sub-accounts of the master account. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $offset = 56; // int | Index of the first sub-account in the page $limit = 56; // int | Number of sub-accounts to be displayed on each page try { $result = $apiInstance->corporateSubAccountGet($offset, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **offset** | **int**| Index of the first sub-account in the page | **limit** | **int**| Number of sub-accounts to be displayed on each page | ### Return type [**\Brevo\Client\Model\SubAccountsResponse**](../Model/SubAccountsResponse.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountIdApplicationsTogglePut** > corporateSubAccountIdApplicationsTogglePut($id, $toggleApplications) Enable/disable sub-account application(s) API endpoint for the Corporate owner to enable/disable applications on the sub-account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $id = 789; // int | Id of the sub-account organization (mandatory) $toggleApplications = new \Brevo\Client\Model\SubAccountAppsToggleRequest(); // \Brevo\Client\Model\SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account try { $apiInstance->corporateSubAccountIdApplicationsTogglePut($id, $toggleApplications); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountIdApplicationsTogglePut: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| Id of the sub-account organization (mandatory) | **toggleApplications** | [**\Brevo\Client\Model\SubAccountAppsToggleRequest**](../Model/SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountIdDelete** > corporateSubAccountIdDelete($id) Delete a sub-account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $id = 789; // int | Id of the sub-account organization to be deleted try { $apiInstance->corporateSubAccountIdDelete($id); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| Id of the sub-account organization to be deleted | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountIdGet** > \Brevo\Client\Model\SubAccountDetailsResponse corporateSubAccountIdGet($id) Get sub-account details This endpoint will provide the details for the specified sub-account company ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $id = 789; // int | Id of the sub-account organization try { $result = $apiInstance->corporateSubAccountIdGet($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountIdGet: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| Id of the sub-account organization | ### Return type [**\Brevo\Client\Model\SubAccountDetailsResponse**](../Model/SubAccountDetailsResponse.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountIdPlanPut** > corporateSubAccountIdPlanPut($id, $updatePlanDetails) Update sub-account plan This endpoint will update the sub-account plan ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $id = 789; // int | Id of the sub-account organization $updatePlanDetails = new \Brevo\Client\Model\SubAccountUpdatePlanRequest(); // \Brevo\Client\Model\SubAccountUpdatePlanRequest | Values to update a sub-account plan try { $apiInstance->corporateSubAccountIdPlanPut($id, $updatePlanDetails); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountIdPlanPut: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **int**| Id of the sub-account organization | **updatePlanDetails** | [**\Brevo\Client\Model\SubAccountUpdatePlanRequest**](../Model/SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountKeyPost** > \Brevo\Client\Model\CreateApiKeyResponse corporateSubAccountKeyPost($createApiKeyRequest) Create an API key for a sub-account This endpoint will generate an API v3 key for a sub account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $createApiKeyRequest = new \Brevo\Client\Model\CreateApiKeyRequest(); // \Brevo\Client\Model\CreateApiKeyRequest | Values to generate API key for sub-account try { $result = $apiInstance->corporateSubAccountKeyPost($createApiKeyRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountKeyPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createApiKeyRequest** | [**\Brevo\Client\Model\CreateApiKeyRequest**](../Model/CreateApiKeyRequest.md)| Values to generate API key for sub-account | ### Return type [**\Brevo\Client\Model\CreateApiKeyResponse**](../Model/CreateApiKeyResponse.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountPost** > \Brevo\Client\Model\CreateSubAccountResponse corporateSubAccountPost($subAccountCreate) Create a new sub-account under a master account. This endpoint will create a new sub-account under a master account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $subAccountCreate = new \Brevo\Client\Model\CreateSubAccount(); // \Brevo\Client\Model\CreateSubAccount | values to create new sub-account try { $result = $apiInstance->corporateSubAccountPost($subAccountCreate); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subAccountCreate** | [**\Brevo\Client\Model\CreateSubAccount**](../Model/CreateSubAccount.md)| values to create new sub-account | ### Return type [**\Brevo\Client\Model\CreateSubAccountResponse**](../Model/CreateSubAccountResponse.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **corporateSubAccountSsoTokenPost** > \Brevo\Client\Model\GetSsoToken corporateSubAccountSsoTokenPost($ssoTokenRequest) Generate SSO token to access Brevo This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $ssoTokenRequest = new \Brevo\Client\Model\SsoTokenRequest(); // \Brevo\Client\Model\SsoTokenRequest | Values to generate SSO token for sub-account try { $result = $apiInstance->corporateSubAccountSsoTokenPost($ssoTokenRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->corporateSubAccountSsoTokenPost: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ssoTokenRequest** | [**\Brevo\Client\Model\SsoTokenRequest**](../Model/SsoTokenRequest.md)| Values to generate SSO token for sub-account | ### Return type [**\Brevo\Client\Model\GetSsoToken**](../Model/GetSsoToken.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAccountActivity** > \Brevo\Client\Model\GetAccountActivity getAccountActivity($startDate, $endDate, $limit, $offset) Get user activity logs ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\MasterAccountApi( // 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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page. try { $result = $apiInstance->getAccountActivity($startDate, $endDate, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling MasterAccountApi->getAccountActivity: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | [optional] **endDate** | **string**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document in the page. | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetAccountActivity**](../Model/GetAccountActivity.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/TransactionalEmailsApi.md 0000644 00000174261 15021222673 0015033 0 ustar 00 # Brevo\Client\TransactionalEmailsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**blockNewDomain**](TransactionalEmailsApi.md#blockNewDomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains [**createSmtpTemplate**](TransactionalEmailsApi.md#createSmtpTemplate) | **POST** /smtp/templates | Create an email template [**deleteBlockedDomain**](TransactionalEmailsApi.md#deleteBlockedDomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains [**deleteHardbounces**](TransactionalEmailsApi.md#deleteHardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces [**deleteScheduledEmailById**](TransactionalEmailsApi.md#deleteScheduledEmailById) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId [**deleteSmtpTemplate**](TransactionalEmailsApi.md#deleteSmtpTemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template [**getAggregatedSmtpReport**](TransactionalEmailsApi.md#getAggregatedSmtpReport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time [**getBlockedDomains**](TransactionalEmailsApi.md#getBlockedDomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains [**getEmailEventReport**](TransactionalEmailsApi.md#getEmailEventReport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) [**getScheduledEmailByBatchId**](TransactionalEmailsApi.md#getScheduledEmailByBatchId) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId [**getScheduledEmailByMessageId**](TransactionalEmailsApi.md#getScheduledEmailByMessageId) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId [**getSmtpReport**](TransactionalEmailsApi.md#getSmtpReport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day [**getSmtpTemplate**](TransactionalEmailsApi.md#getSmtpTemplate) | **GET** /smtp/templates/{templateId} | Returns the template information [**getSmtpTemplates**](TransactionalEmailsApi.md#getSmtpTemplates) | **GET** /smtp/templates | Get the list of email templates [**getTransacBlockedContacts**](TransactionalEmailsApi.md#getTransacBlockedContacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts [**getTransacEmailContent**](TransactionalEmailsApi.md#getTransacEmailContent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email [**getTransacEmailsList**](TransactionalEmailsApi.md#getTransacEmailsList) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters [**sendTestTemplate**](TransactionalEmailsApi.md#sendTestTemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list [**sendTransacEmail**](TransactionalEmailsApi.md#sendTransacEmail) | **POST** /smtp/email | Send a transactional email [**smtpBlockedContactsEmailDelete**](TransactionalEmailsApi.md#smtpBlockedContactsEmailDelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact [**smtpLogMessageIdDelete**](TransactionalEmailsApi.md#smtpLogMessageIdDelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log [**updateSmtpTemplate**](TransactionalEmailsApi.md#updateSmtpTemplate) | **PUT** /smtp/templates/{templateId} | Update an email template # **blockNewDomain** > blockNewDomain($blockDomain) Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $blockDomain = new \Brevo\Client\Model\BlockDomain(); // \Brevo\Client\Model\BlockDomain | try { $apiInstance->blockNewDomain($blockDomain); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->blockNewDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **blockDomain** | [**\Brevo\Client\Model\BlockDomain**](../Model/BlockDomain.md)| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createSmtpTemplate** > \Brevo\Client\Model\CreateModel createSmtpTemplate($smtpTemplate) Create an email template ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $smtpTemplate = new \Brevo\Client\Model\CreateSmtpTemplate(); // \Brevo\Client\Model\CreateSmtpTemplate | values to update in transactional email template try { $result = $apiInstance->createSmtpTemplate($smtpTemplate); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->createSmtpTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **smtpTemplate** | [**\Brevo\Client\Model\CreateSmtpTemplate**](../Model/CreateSmtpTemplate.md)| values to update in transactional email template | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteBlockedDomain** > deleteBlockedDomain($domain) Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $domain = "domain_example"; // string | The name of the domain to be deleted try { $apiInstance->deleteBlockedDomain($domain); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->deleteBlockedDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **domain** | **string**| The name of the domain to be deleted | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteHardbounces** > deleteHardbounces($deleteHardbounces) Delete hardbounces Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $deleteHardbounces = new \Brevo\Client\Model\DeleteHardbounces(); // \Brevo\Client\Model\DeleteHardbounces | values to delete hardbounces try { $apiInstance->deleteHardbounces($deleteHardbounces); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->deleteHardbounces: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **deleteHardbounces** | [**\Brevo\Client\Model\DeleteHardbounces**](../Model/DeleteHardbounces.md)| values to delete hardbounces | [optional] ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteScheduledEmailById** > deleteScheduledEmailById($identifier) Delete scheduled emails by batchId or messageId Delete scheduled batch of emails by batchId or single scheduled email by messageId ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $identifier = "identifier_example"; // string | The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. try { $apiInstance->deleteScheduledEmailById($identifier); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->deleteScheduledEmailById: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **string**| The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteSmtpTemplate** > deleteSmtpTemplate($templateId) Delete an inactive email template ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $templateId = 789; // int | id of the template try { $apiInstance->deleteSmtpTemplate($templateId); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->deleteSmtpTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **int**| id of the template | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAggregatedSmtpReport** > \Brevo\Client\Model\GetAggregatedReport getAggregatedSmtpReport($startDate, $endDate, $days, $tag) Get your transactional email activity aggregated over a period of time This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' $tag = "tag_example"; // string | Tag of the emails try { $result = $apiInstance->getAggregatedSmtpReport($startDate, $endDate, $days, $tag); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getAggregatedSmtpReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **tag** | **string**| Tag of the emails | [optional] ### Return type [**\Brevo\Client\Model\GetAggregatedReport**](../Model/GetAggregatedReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getBlockedDomains** > \Brevo\Client\Model\GetBlockedDomains getBlockedDomains() Get the list of blocked domains Get the list of blocked domains ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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->getBlockedDomains(); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getBlockedDomains: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetBlockedDomains**](../Model/GetBlockedDomains.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getEmailEventReport** > \Brevo\Client\Model\GetEmailEventReport getEmailEventReport($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort) Get all your transactional email activity (unaggregated events) This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $limit = 2500; // int | Number limitation for the result returned $offset = 0; // int | Beginning point in the list to retrieve from. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' $email = "email_example"; // string | Filter the report for a specific email addresses $event = "event_example"; // string | Filter the report for a specific event type $tags = "tags_example"; // string | Filter the report for tags (serialized and urlencoded array) $messageId = "messageId_example"; // string | Filter on a specific message id $templateId = 789; // int | Filter on a specific template id $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getEmailEventReport($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getEmailEventReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number limitation for the result returned | [optional] [default to 2500] **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] **startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **email** | **string**| Filter the report for a specific email addresses | [optional] **event** | **string**| Filter the report for a specific event type | [optional] **tags** | **string**| Filter the report for tags (serialized and urlencoded array) | [optional] **messageId** | **string**| Filter on a specific message id | [optional] **templateId** | **int**| Filter on a specific template id | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetEmailEventReport**](../Model/GetEmailEventReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getScheduledEmailByBatchId** > \Brevo\Client\Model\GetScheduledEmailByBatchId getScheduledEmailByBatchId($batchId, $startDate, $endDate, $sort, $status, $limit, $offset) Fetch scheduled emails by batchId Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $batchId = "batchId_example"; // string | The batchId of scheduled emails batch (Should be a valid UUIDv4) $startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. $endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed $status = "status_example"; // string | Filter the records by `status` of the scheduled email batch or message. $limit = 100; // int | Number of documents returned per page $offset = 0; // int | Index of the first document on the page try { $result = $apiInstance->getScheduledEmailByBatchId($batchId, $startDate, $endDate, $sort, $status, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getScheduledEmailByBatchId: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **batchId** | **string**| The batchId of scheduled emails batch (Should be a valid UUIDv4) | **startDate** | **\DateTime**| Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] **endDate** | **\DateTime**| Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] **status** | **string**| Filter the records by `status` of the scheduled email batch or message. | [optional] **limit** | **int**| Number of documents returned per page | [optional] [default to 100] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetScheduledEmailByBatchId**](../Model/GetScheduledEmailByBatchId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getScheduledEmailByMessageId** > \Brevo\Client\Model\GetScheduledEmailByMessageId getScheduledEmailByMessageId($messageId, $startDate, $endDate) Fetch scheduled email by messageId Fetch scheduled email by messageId (Can retrieve data upto 30 days old) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $messageId = "messageId_example"; // string | The messageId of scheduled email $startDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. $endDate = new \DateTime("2013-10-20"); // \DateTime | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. try { $result = $apiInstance->getScheduledEmailByMessageId($messageId, $startDate, $endDate); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getScheduledEmailByMessageId: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **messageId** | **string**| The messageId of scheduled email | **startDate** | **\DateTime**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | [optional] **endDate** | **\DateTime**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] ### Return type [**\Brevo\Client\Model\GetScheduledEmailByMessageId**](../Model/GetScheduledEmailByMessageId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSmtpReport** > \Brevo\Client\Model\GetReports getSmtpReport($limit, $offset, $startDate, $endDate, $days, $tag, $sort) Get your transactional email activity aggregated per day ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $limit = 10; // int | Number of documents returned per page $offset = 0; // int | Index of the first document on the page $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) $days = 789; // int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' $tag = "tag_example"; // string | Tag of the emails $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getSmtpReport($limit, $offset, $startDate, $endDate, $days, $tag, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getSmtpReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents returned per page | [optional] [default to 10] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] **startDate** | **string**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **tag** | **string**| Tag of the emails | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetReports**](../Model/GetReports.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSmtpTemplate** > \Brevo\Client\Model\GetSmtpTemplateOverview getSmtpTemplate($templateId) Returns the template information ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $templateId = 789; // int | id of the template try { $result = $apiInstance->getSmtpTemplate($templateId); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getSmtpTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **int**| id of the template | ### Return type [**\Brevo\Client\Model\GetSmtpTemplateOverview**](../Model/GetSmtpTemplateOverview.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSmtpTemplates** > \Brevo\Client\Model\GetSmtpTemplates getSmtpTemplates($templateStatus, $limit, $offset, $sort) Get the list of email templates ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $templateStatus = true; // bool | Filter on the status of the template. Active = true, inactive = false $limit = 50; // int | Number of documents returned per page $offset = 0; // int | Index of the first document in the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getSmtpTemplates($templateStatus, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getSmtpTemplates: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateStatus** | **bool**| Filter on the status of the template. Active = true, inactive = false | [optional] **limit** | **int**| Number of documents returned per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetSmtpTemplates**](../Model/GetSmtpTemplates.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getTransacBlockedContacts** > \Brevo\Client\Model\GetTransacBlockedContacts getTransacBlockedContacts($startDate, $endDate, $limit, $offset, $senders, $sort) Get the list of blocked or unsubscribed transactional contacts ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts $limit = 50; // int | Number of documents returned per page $offset = 0; // int | Index of the first document on the page $senders = array("senders_example"); // string[] | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getTransacBlockedContacts($startDate, $endDate, $limit, $offset, $senders, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getTransacBlockedContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional] **limit** | **int**| Number of documents returned per page | [optional] [default to 50] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] **senders** | [**string[]**](../Model/string.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetTransacBlockedContacts**](../Model/GetTransacBlockedContacts.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getTransacEmailContent** > \Brevo\Client\Model\GetTransacEmailContent getTransacEmailContent($uuid) Get the personalized content of a sent transactional email ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $uuid = "uuid_example"; // string | Unique id of the transactional email that has been sent to a particular contact try { $result = $apiInstance->getTransacEmailContent($uuid); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getTransacEmailContent: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **uuid** | **string**| Unique id of the transactional email that has been sent to a particular contact | ### Return type [**\Brevo\Client\Model\GetTransacEmailContent**](../Model/GetTransacEmailContent.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getTransacEmailsList** > \Brevo\Client\Model\GetTransacEmailsList getTransacEmailsList($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset) Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $email = "email_example"; // string | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. $templateId = 789; // int | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. $messageId = "messageId_example"; // string | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed $limit = 500; // int | Number of documents returned per page $offset = 0; // int | Index of the first document in the page try { $result = $apiInstance->getTransacEmailsList($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->getTransacEmailsList: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **string**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional] **templateId** | **int**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional] **messageId** | **string**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional] **startDate** | **string**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] **limit** | **int**| Number of documents returned per page | [optional] [default to 500] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetTransacEmailsList**](../Model/GetTransacEmailsList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendTestTemplate** > sendTestTemplate($templateId, $sendTestEmail) Send a template to your test list ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $templateId = 789; // int | Id of the template $sendTestEmail = new \Brevo\Client\Model\SendTestEmail(); // \Brevo\Client\Model\SendTestEmail | try { $apiInstance->sendTestTemplate($templateId, $sendTestEmail); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->sendTestTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **int**| Id of the template | **sendTestEmail** | [**\Brevo\Client\Model\SendTestEmail**](../Model/SendTestEmail.md)| | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendTransacEmail** > \Brevo\Client\Model\CreateSmtpEmail sendTransacEmail($sendSmtpEmail) Send a transactional email ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $sendSmtpEmail = new \Brevo\Client\Model\SendSmtpEmail(); // \Brevo\Client\Model\SendSmtpEmail | Values to send a transactional email try { $result = $apiInstance->sendTransacEmail($sendSmtpEmail); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->sendTransacEmail: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sendSmtpEmail** | [**\Brevo\Client\Model\SendSmtpEmail**](../Model/SendSmtpEmail.md)| Values to send a transactional email | ### Return type [**\Brevo\Client\Model\CreateSmtpEmail**](../Model/CreateSmtpEmail.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **smtpBlockedContactsEmailDelete** > smtpBlockedContactsEmailDelete($email) Unblock or resubscribe a transactional contact ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $email = "email_example"; // string | contact email (urlencoded) to unblock. try { $apiInstance->smtpBlockedContactsEmailDelete($email); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->smtpBlockedContactsEmailDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **email** | **string**| contact email (urlencoded) to unblock. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **smtpLogMessageIdDelete** > smtpLogMessageIdDelete($messageId) Delete an SMTP transactional log ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $messageId = "messageId_example"; // string | MessageId of the transactional log to delete try { $apiInstance->smtpLogMessageIdDelete($messageId); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->smtpLogMessageIdDelete: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **messageId** | **string**| MessageId of the transactional log to delete | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateSmtpTemplate** > updateSmtpTemplate($templateId, $smtpTemplate) Update an email template ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalEmailsApi( // 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 ); $templateId = 789; // int | id of the template $smtpTemplate = new \Brevo\Client\Model\UpdateSmtpTemplate(); // \Brevo\Client\Model\UpdateSmtpTemplate | values to update in transactional email template try { $apiInstance->updateSmtpTemplate($templateId, $smtpTemplate); } catch (Exception $e) { echo 'Exception when calling TransactionalEmailsApi->updateSmtpTemplate: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **templateId** | **int**| id of the template | **smtpTemplate** | [**\Brevo\Client\Model\UpdateSmtpTemplate**](../Model/UpdateSmtpTemplate.md)| values to update in transactional email template | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/TransactionalWhatsAppApi.md 0000644 00000016322 15021222673 0015341 0 ustar 00 # Brevo\Client\TransactionalWhatsAppApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getWhatsappEventReport**](TransactionalWhatsAppApi.md#getWhatsappEventReport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events) [**sendWhatsappMessage**](TransactionalWhatsAppApi.md#sendWhatsappMessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message # **getWhatsappEventReport** > \Brevo\Client\Model\GetWhatsappEventReport getWhatsappEventReport($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort) Get all your WhatsApp activity (unaggregated events) This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if `startDate` and `endDate` or `days` is not passed. The date range can not exceed 90 days) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalWhatsAppApi( // 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 ); $limit = 2500; // int | Number limitation for the result returned $offset = 0; // int | Beginning point in the list to retrieve from $startDate = "startDate_example"; // string | **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate $endDate = "endDate_example"; // string | **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate $days = 789; // int | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ $contactNumber = "contactNumber_example"; // string | Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) $event = "event_example"; // string | Filter the report for a specific event type $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getWhatsappEventReport($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalWhatsAppApi->getWhatsappEventReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number limitation for the result returned | [optional] [default to 2500] **offset** | **int**| Beginning point in the list to retrieve from | [optional] [default to 0] **startDate** | **string**| **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional] **endDate** | **string**| **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] **days** | **int**| Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ | [optional] **contactNumber** | **string**| Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) | [optional] **event** | **string**| Filter the report for a specific event type | [optional] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetWhatsappEventReport**](../Model/GetWhatsappEventReport.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendWhatsappMessage** > \Brevo\Client\Model\InlineResponse2013 sendWhatsappMessage($sendWhatsappMessage) Send a WhatsApp message This endpoint is used to send a WhatsApp message. <br/>(**The first message you send using the API must contain a Template ID. You must create a template on WhatsApp on the Brevo platform to fetch the Template ID.**) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\TransactionalWhatsAppApi( // 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 ); $sendWhatsappMessage = new \Brevo\Client\Model\SendWhatsappMessage(); // \Brevo\Client\Model\SendWhatsappMessage | Values to send WhatsApp message try { $result = $apiInstance->sendWhatsappMessage($sendWhatsappMessage); print_r($result); } catch (Exception $e) { echo 'Exception when calling TransactionalWhatsAppApi->sendWhatsappMessage: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sendWhatsappMessage** | [**\Brevo\Client\Model\SendWhatsappMessage**](../Model/SendWhatsappMessage.md)| Values to send WhatsApp message | ### Return type [**\Brevo\Client\Model\InlineResponse2013**](../Model/InlineResponse2013.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ProcessApi.md 0000644 00000011606 15021222673 0012505 0 ustar 00 # Brevo\Client\ProcessApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getProcess**](ProcessApi.md#getProcess) | **GET** /processes/{processId} | Return the informations for a process [**getProcesses**](ProcessApi.md#getProcesses) | **GET** /processes | Return all the processes for your account # **getProcess** > \Brevo\Client\Model\GetProcess getProcess($processId) Return the informations for a process ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ProcessApi( // 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 ); $processId = 789; // int | Id of the process try { $result = $apiInstance->getProcess($processId); print_r($result); } catch (Exception $e) { echo 'Exception when calling ProcessApi->getProcess: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **processId** | **int**| Id of the process | ### Return type [**\Brevo\Client\Model\GetProcess**](../Model/GetProcess.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getProcesses** > \Brevo\Client\Model\GetProcesses getProcesses($limit, $offset, $sort) Return all the processes for your account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ProcessApi( // 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 ); $limit = 10; // int | Number limitation for the result returned $offset = 0; // int | Beginning point in the list to retrieve from. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getProcesses($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number limitation for the result returned | [optional] [default to 10] **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetProcesses**](../Model/GetProcesses.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/WebhooksApi.md 0000644 00000032607 15021222673 0012654 0 ustar 00 # Brevo\Client\WebhooksApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createWebhook**](WebhooksApi.md#createWebhook) | **POST** /webhooks | Create a webhook [**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook [**exportWebhooksHistory**](WebhooksApi.md#exportWebhooksHistory) | **POST** /webhooks/export | Export all transactional events [**getWebhook**](WebhooksApi.md#getWebhook) | **GET** /webhooks/{webhookId} | Get a webhook details [**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all webhooks [**updateWebhook**](WebhooksApi.md#updateWebhook) | **PUT** /webhooks/{webhookId} | Update a webhook # **createWebhook** > \Brevo\Client\Model\CreateModel createWebhook($createWebhook) Create a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $createWebhook = new \Brevo\Client\Model\CreateWebhook(); // \Brevo\Client\Model\CreateWebhook | Values to create a webhook try { $result = $apiInstance->createWebhook($createWebhook); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createWebhook** | [**\Brevo\Client\Model\CreateWebhook**](../Model/CreateWebhook.md)| Values to create a webhook | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteWebhook** > deleteWebhook($webhookId) Delete a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $webhookId = 789; // int | Id of the webhook try { $apiInstance->deleteWebhook($webhookId); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->deleteWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **exportWebhooksHistory** > \Brevo\Client\Model\CreatedProcessId exportWebhooksHistory($exportWebhookHistory) Export all transactional events This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download that CSV file will send to the webhook link provided in notifyURL of the body payload. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $exportWebhookHistory = new \Brevo\Client\Model\ExportWebhooksHistory(); // \Brevo\Client\Model\ExportWebhooksHistory | Values to submit for webhooks history try { $result = $apiInstance->exportWebhooksHistory($exportWebhookHistory); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->exportWebhooksHistory: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **exportWebhookHistory** | [**\Brevo\Client\Model\ExportWebhooksHistory**](../Model/ExportWebhooksHistory.md)| Values to submit for webhooks history | ### Return type [**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWebhook** > \Brevo\Client\Model\GetWebhook getWebhook($webhookId) Get a webhook details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $webhookId = 789; // int | Id of the webhook try { $result = $apiInstance->getWebhook($webhookId); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->getWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | ### Return type [**\Brevo\Client\Model\GetWebhook**](../Model/GetWebhook.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getWebhooks** > \Brevo\Client\Model\GetWebhooks getWebhooks($type, $sort) Get all webhooks ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $type = "transactional"; // string | Filter on webhook type $sort = "desc"; // string | Sort the results in the ascending/descending order of webhook creation try { $result = $apiInstance->getWebhooks($type, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->getWebhooks: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **type** | **string**| Filter on webhook type | [optional] [default to transactional] **sort** | **string**| Sort the results in the ascending/descending order of webhook creation | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetWebhooks**](../Model/GetWebhooks.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateWebhook** > updateWebhook($webhookId, $updateWebhook) Update a webhook ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\WebhooksApi( // 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 ); $webhookId = 789; // int | Id of the webhook $updateWebhook = new \Brevo\Client\Model\UpdateWebhook(); // \Brevo\Client\Model\UpdateWebhook | Values to update a webhook try { $apiInstance->updateWebhook($webhookId, $updateWebhook); } catch (Exception $e) { echo 'Exception when calling WebhooksApi->updateWebhook: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhookId** | **int**| Id of the webhook | **updateWebhook** | [**\Brevo\Client\Model\UpdateWebhook**](../Model/UpdateWebhook.md)| Values to update a webhook | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/CouponsApi.md 0000644 00000027606 15021222673 0012524 0 ustar 00 # Brevo\Client\CouponsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createCouponCollection**](CouponsApi.md#createCouponCollection) | **POST** /couponCollections | Create а coupon collection [**createCoupons**](CouponsApi.md#createCoupons) | **POST** /coupons | Create coupons for a coupon collection [**getCouponCollection**](CouponsApi.md#getCouponCollection) | **GET** /couponCollections/{id} | Get a coupon collection by id [**getCouponCollections**](CouponsApi.md#getCouponCollections) | **GET** /couponCollections | Get all your coupon collections [**updateCouponCollection**](CouponsApi.md#updateCouponCollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id # **createCouponCollection** > \Brevo\Client\Model\InlineResponse2012 createCouponCollection($createCouponCollection) Create а coupon collection ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CouponsApi( // 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 ); $createCouponCollection = new \Brevo\Client\Model\CreateCouponCollection(); // \Brevo\Client\Model\CreateCouponCollection | Values to create a coupon collection try { $result = $apiInstance->createCouponCollection($createCouponCollection); print_r($result); } catch (Exception $e) { echo 'Exception when calling CouponsApi->createCouponCollection: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createCouponCollection** | [**\Brevo\Client\Model\CreateCouponCollection**](../Model/CreateCouponCollection.md)| Values to create a coupon collection | ### Return type [**\Brevo\Client\Model\InlineResponse2012**](../Model/InlineResponse2012.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createCoupons** > createCoupons($createCoupons) Create coupons for a coupon collection ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CouponsApi( // 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 ); $createCoupons = new \Brevo\Client\Model\CreateCoupons(); // \Brevo\Client\Model\CreateCoupons | Values to create coupons try { $apiInstance->createCoupons($createCoupons); } catch (Exception $e) { echo 'Exception when calling CouponsApi->createCoupons: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createCoupons** | [**\Brevo\Client\Model\CreateCoupons**](../Model/CreateCoupons.md)| Values to create coupons | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getCouponCollection** > \Brevo\Client\Model\GetCouponCollection getCouponCollection($id) Get a coupon collection by id ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CouponsApi( // 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 ); $id = "id_example"; // string | Id of the collection to return try { $result = $apiInstance->getCouponCollection($id); print_r($result); } catch (Exception $e) { echo 'Exception when calling CouponsApi->getCouponCollection: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Id of the collection to return | ### Return type [**\Brevo\Client\Model\GetCouponCollection**](../Model/GetCouponCollection.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getCouponCollections** > \Brevo\Client\Model\GetCouponCollection getCouponCollections($limit, $offset, $sort) Get all your coupon collections ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CouponsApi( // 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 ); $limit = 50; // int | Number of documents returned per page $offset = 0; // int | Index of the first document on the page $sort = "desc"; // string | Sort the results by creation time in ascending/descending order try { $result = $apiInstance->getCouponCollections($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling CouponsApi->getCouponCollections: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents returned per page | [optional] [default to 50] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] **sort** | **string**| Sort the results by creation time in ascending/descending order | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetCouponCollection**](../Model/GetCouponCollection.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateCouponCollection** > \Brevo\Client\Model\InlineResponse2001 updateCouponCollection($id, $updateCouponCollection) Update a coupon collection by id ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\CouponsApi( // 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 ); $id = "id_example"; // string | Id of the collection to update $updateCouponCollection = new \Brevo\Client\Model\UpdateCouponCollection(); // \Brevo\Client\Model\UpdateCouponCollection | Values to update the coupon collection try { $result = $apiInstance->updateCouponCollection($id, $updateCouponCollection); print_r($result); } catch (Exception $e) { echo 'Exception when calling CouponsApi->updateCouponCollection: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **string**| Id of the collection to update | **updateCouponCollection** | [**\Brevo\Client\Model\UpdateCouponCollection**](../Model/UpdateCouponCollection.md)| Values to update the coupon collection | ### Return type [**\Brevo\Client\Model\InlineResponse2001**](../Model/InlineResponse2001.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/AccountApi.md 0000644 00000012731 15021222673 0012463 0 ustar 00 # Brevo\Client\AccountApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**getAccount**](AccountApi.md#getAccount) | **GET** /account | Get your account information, plan and credits details [**getAccountActivity**](AccountApi.md#getAccountActivity) | **GET** /organization/activities | Get user activity logs # **getAccount** > \Brevo\Client\Model\GetAccount getAccount() Get your account information, plan and credits details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\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->getAccount(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\Brevo\Client\Model\GetAccount**](../Model/GetAccount.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getAccountActivity** > \Brevo\Client\Model\GetAccountActivity getAccountActivity($startDate, $endDate, $limit, $offset) Get user activity logs ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\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 ); $startDate = "startDate_example"; // string | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. $endDate = "endDate_example"; // string | Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document in the page. try { $result = $apiInstance->getAccountActivity($startDate, $endDate, $limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccountActivity: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **startDate** | **string**| Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. | [optional] **endDate** | **string**| Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document in the page. | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetAccountActivity**](../Model/GetAccountActivity.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/FoldersApi.md 0000644 00000033516 15021222673 0012471 0 ustar 00 # Brevo\Client\FoldersApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createFolder**](FoldersApi.md#createFolder) | **POST** /contacts/folders | Create a folder [**deleteFolder**](FoldersApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) [**getFolder**](FoldersApi.md#getFolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details [**getFolderLists**](FoldersApi.md#getFolderLists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder [**getFolders**](FoldersApi.md#getFolders) | **GET** /contacts/folders | Get all folders [**updateFolder**](FoldersApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a folder # **createFolder** > \Brevo\Client\Model\CreateModel createFolder($createFolder) Create a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $createFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder try { $result = $apiInstance->createFolder($createFolder); print_r($result); } catch (Exception $e) { echo 'Exception when calling FoldersApi->createFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteFolder** > deleteFolder($folderId) Delete a folder (and all its lists) ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $folderId = 789; // int | Id of the folder try { $apiInstance->deleteFolder($folderId); } catch (Exception $e) { echo 'Exception when calling FoldersApi->deleteFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolder** > \Brevo\Client\Model\GetFolder getFolder($folderId) Returns a folder's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $folderId = 789; // int | id of the folder try { $result = $apiInstance->getFolder($folderId); print_r($result); } catch (Exception $e) { echo 'Exception when calling FoldersApi->getFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| id of the folder | ### Return type [**\Brevo\Client\Model\GetFolder**](../Model/GetFolder.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolderLists** > \Brevo\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort) Get lists in a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $folderId = 789; // int | Id of the folder $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling FoldersApi->getFolderLists: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetFolderLists**](../Model/GetFolderLists.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getFolders** > \Brevo\Client\Model\GetFolders getFolders($limit, $offset, $sort) Get all folders ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $limit = 10; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getFolders($limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling FoldersApi->getFolders: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [default to 10] **offset** | **int**| Index of the first document of the page | [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetFolders**](../Model/GetFolders.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateFolder** > updateFolder($folderId, $updateFolder) Update a folder ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\FoldersApi( // 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 ); $folderId = 789; // int | Id of the folder $updateFolder = new \Brevo\Client\Model\CreateUpdateFolder(); // \Brevo\Client\Model\CreateUpdateFolder | Name of the folder try { $apiInstance->updateFolder($folderId, $updateFolder); } catch (Exception $e) { echo 'Exception when calling FoldersApi->updateFolder: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **folderId** | **int**| Id of the folder | **updateFolder** | [**\Brevo\Client\Model\CreateUpdateFolder**](../Model/CreateUpdateFolder.md)| Name of the folder | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/SMSCampaignsApi.md 0000644 00000061716 15021222673 0013363 0 ustar 00 # Brevo\Client\SMSCampaignsApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createSmsCampaign**](SMSCampaignsApi.md#createSmsCampaign) | **POST** /smsCampaigns | Creates an SMS campaign [**deleteSmsCampaign**](SMSCampaignsApi.md#deleteSmsCampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign [**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign [**getSmsCampaigns**](SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns [**requestSmsRecipientExport**](SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients [**sendSmsCampaignNow**](SMSCampaignsApi.md#sendSmsCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately [**sendSmsReport**](SMSCampaignsApi.md#sendSmsReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report [**sendTestSms**](SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign [**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign [**updateSmsCampaignStatus**](SMSCampaignsApi.md#updateSmsCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status # **createSmsCampaign** > \Brevo\Client\Model\CreateModel createSmsCampaign($createSmsCampaign) Creates an SMS campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $createSmsCampaign = new \Brevo\Client\Model\CreateSmsCampaign(); // \Brevo\Client\Model\CreateSmsCampaign | Values to create an SMS Campaign try { $result = $apiInstance->createSmsCampaign($createSmsCampaign); print_r($result); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->createSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **createSmsCampaign** | [**\Brevo\Client\Model\CreateSmsCampaign**](../Model/CreateSmsCampaign.md)| Values to create an SMS Campaign | ### Return type [**\Brevo\Client\Model\CreateModel**](../Model/CreateModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteSmsCampaign** > deleteSmsCampaign($campaignId) Delete an SMS campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the SMS campaign try { $apiInstance->deleteSmsCampaign($campaignId); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->deleteSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the SMS campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSmsCampaign** > \Brevo\Client\Model\GetSmsCampaign getSmsCampaign($campaignId) Get an SMS campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the SMS campaign try { $result = $apiInstance->getSmsCampaign($campaignId); print_r($result); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->getSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the SMS campaign | ### Return type [**\Brevo\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSmsCampaigns** > \Brevo\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort) Returns the information for all your created SMS campaigns ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $status = "status_example"; // string | Status of campaign. $startDate = "startDate_example"; // string | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) $endDate = "endDate_example"; // string | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) $limit = 500; // int | Number limitation for the result returned $offset = 0; // int | Beginning point in the list to retrieve from. $sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed try { $result = $apiInstance->getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort); print_r($result); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->getSmsCampaigns: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | **string**| Status of campaign. | [optional] **startDate** | **string**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **endDate** | **string**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **limit** | **int**| Number limitation for the result returned | [optional] [default to 500] **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] **sort** | **string**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type [**\Brevo\Client\Model\GetSmsCampaigns**](../Model/GetSmsCampaigns.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **requestSmsRecipientExport** > \Brevo\Client\Model\CreatedProcessId requestSmsRecipientExport($campaignId, $recipientExport) Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign $recipientExport = new \Brevo\Client\Model\RequestSmsRecipientExport(); // \Brevo\Client\Model\RequestSmsRecipientExport | Values to send for a recipient export request try { $result = $apiInstance->requestSmsRecipientExport($campaignId, $recipientExport); print_r($result); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->requestSmsRecipientExport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | **recipientExport** | [**\Brevo\Client\Model\RequestSmsRecipientExport**](../Model/RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional] ### Return type [**\Brevo\Client\Model\CreatedProcessId**](../Model/CreatedProcessId.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendSmsCampaignNow** > sendSmsCampaignNow($campaignId) Send your SMS campaign immediately ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign try { $apiInstance->sendSmsCampaignNow($campaignId); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->sendSmsCampaignNow: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendSmsReport** > sendSmsReport($campaignId, $sendReport) Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign $sendReport = new \Brevo\Client\Model\SendReport(); // \Brevo\Client\Model\SendReport | Values for send a report try { $apiInstance->sendSmsReport($campaignId, $sendReport); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | **sendReport** | [**\Brevo\Client\Model\SendReport**](../Model/SendReport.md)| Values for send a report | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **sendTestSms** > sendTestSms($campaignId, $phoneNumber) Send a test SMS campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | Id of the SMS campaign $phoneNumber = new \Brevo\Client\Model\SendTestSms(); // \Brevo\Client\Model\SendTestSms | Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted try { $apiInstance->sendTestSms($campaignId, $phoneNumber); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->sendTestSms: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| Id of the SMS campaign | **phoneNumber** | [**\Brevo\Client\Model\SendTestSms**](../Model/SendTestSms.md)| Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateSmsCampaign** > updateSmsCampaign($campaignId, $updateSmsCampaign) Update an SMS campaign ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the SMS campaign $updateSmsCampaign = new \Brevo\Client\Model\UpdateSmsCampaign(); // \Brevo\Client\Model\UpdateSmsCampaign | Values to update an SMS Campaign try { $apiInstance->updateSmsCampaign($campaignId, $updateSmsCampaign); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->updateSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the SMS campaign | **updateSmsCampaign** | [**\Brevo\Client\Model\UpdateSmsCampaign**](../Model/UpdateSmsCampaign.md)| Values to update an SMS Campaign | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateSmsCampaignStatus** > updateSmsCampaignStatus($campaignId, $status) Update a campaign's status ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\SMSCampaignsApi( // 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 ); $campaignId = 789; // int | id of the campaign $status = new \Brevo\Client\Model\UpdateCampaignStatus(); // \Brevo\Client\Model\UpdateCampaignStatus | Status of the campaign. try { $apiInstance->updateSmsCampaignStatus($campaignId, $status); } catch (Exception $e) { echo 'Exception when calling SMSCampaignsApi->updateSmsCampaignStatus: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | **status** | [**\Brevo\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Api/ResellerApi.md 0000644 00000116362 15021222673 0012651 0 ustar 00 # Brevo\Client\ResellerApi All URIs are relative to *https://api.brevo.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**addCredits**](ResellerApi.md#addCredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account [**associateIpToChild**](ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child [**createChildDomain**](ResellerApi.md#createChildDomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account [**createResellerChild**](ResellerApi.md#createResellerChild) | **POST** /reseller/children | Creates a reseller child [**deleteChildDomain**](ResellerApi.md#deleteChildDomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed [**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied [**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child [**getChildAccountCreationStatus**](ResellerApi.md#getChildAccountCreationStatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied [**getChildDomains**](ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account [**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details [**getResellerChilds**](ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Get the list of all children accounts [**getSsoToken**](ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO) [**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account [**updateChildAccountStatus**](ResellerApi.md#updateChildAccountStatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied [**updateChildDomain**](ResellerApi.md#updateChildDomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed [**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied # **addCredits** > \Brevo\Client\Model\RemainingCreditModel addCredits($childIdentifier, $addCredits) Add Email and/or SMS credits to a specific child account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $addCredits = new \Brevo\Client\Model\AddCredits(); // \Brevo\Client\Model\AddCredits | Values to post to add credit to a specific child account try { $result = $apiInstance->addCredits($childIdentifier, $addCredits); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->addCredits: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **addCredits** | [**\Brevo\Client\Model\AddCredits**](../Model/AddCredits.md)| Values to post to add credit to a specific child account | ### Return type [**\Brevo\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **associateIpToChild** > associateIpToChild($childIdentifier, $ip) Associate a dedicated IP to the child ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to associate try { $apiInstance->associateIpToChild($childIdentifier, $ip); } catch (Exception $e) { echo 'Exception when calling ResellerApi->associateIpToChild: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **ip** | [**\Brevo\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to associate | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createChildDomain** > createChildDomain($childIdentifier, $addChildDomain) Create a domain for a child account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $addChildDomain = new \Brevo\Client\Model\AddChildDomain(); // \Brevo\Client\Model\AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account. try { $apiInstance->createChildDomain($childIdentifier, $addChildDomain); } catch (Exception $e) { echo 'Exception when calling ResellerApi->createChildDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **addChildDomain** | [**\Brevo\Client\Model\AddChildDomain**](../Model/AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **createResellerChild** > \Brevo\Client\Model\CreateReseller createResellerChild($resellerChild) Creates a reseller child ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $resellerChild = new \Brevo\Client\Model\CreateChild(); // \Brevo\Client\Model\CreateChild | reseller child to add try { $result = $apiInstance->createResellerChild($resellerChild); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->createResellerChild: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **resellerChild** | [**\Brevo\Client\Model\CreateChild**](../Model/CreateChild.md)| reseller child to add | [optional] ### Return type [**\Brevo\Client\Model\CreateReseller**](../Model/CreateReseller.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteChildDomain** > deleteChildDomain($childIdentifier, $domainName) Delete the sender domain of the reseller child based on the childIdentifier and domainName passed ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $domainName = "domainName_example"; // string | Pass the existing domain that needs to be deleted try { $apiInstance->deleteChildDomain($childIdentifier, $domainName); } catch (Exception $e) { echo 'Exception when calling ResellerApi->deleteChildDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **domainName** | **string**| Pass the existing domain that needs to be deleted | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **deleteResellerChild** > deleteResellerChild($childIdentifier) Delete a single reseller child based on the child identifier supplied ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or child id of reseller's child try { $apiInstance->deleteResellerChild($childIdentifier); } catch (Exception $e) { echo 'Exception when calling ResellerApi->deleteResellerChild: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or child id of reseller's child | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **dissociateIpFromChild** > dissociateIpFromChild($childIdentifier, $ip) Dissociate a dedicated IP to the child ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $ip = new \Brevo\Client\Model\ManageIp(); // \Brevo\Client\Model\ManageIp | IP to dissociate try { $apiInstance->dissociateIpFromChild($childIdentifier, $ip); } catch (Exception $e) { echo 'Exception when calling ResellerApi->dissociateIpFromChild: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **ip** | [**\Brevo\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to dissociate | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getChildAccountCreationStatus** > \Brevo\Client\Model\GetChildAccountCreationStatus getChildAccountCreationStatus($childIdentifier) Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child try { $result = $apiInstance->getChildAccountCreationStatus($childIdentifier); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->getChildAccountCreationStatus: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type [**\Brevo\Client\Model\GetChildAccountCreationStatus**](../Model/GetChildAccountCreationStatus.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getChildDomains** > \Brevo\Client\Model\GetChildDomains getChildDomains($childIdentifier) Get all sender domains for a specific child account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child try { $result = $apiInstance->getChildDomains($childIdentifier); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->getChildDomains: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type [**\Brevo\Client\Model\GetChildDomains**](../Model/GetChildDomains.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getChildInfo** > \Brevo\Client\Model\GetChildInfo getChildInfo($childIdentifier) Get a child account's details ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child try { $result = $apiInstance->getChildInfo($childIdentifier); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->getChildInfo: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type [**\Brevo\Client\Model\GetChildInfo**](../Model/GetChildInfo.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getResellerChilds** > \Brevo\Client\Model\GetChildrenList getResellerChilds($limit, $offset) Get the list of all children accounts ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $limit = 10; // int | Number of documents for child accounts information per page $offset = 0; // int | Index of the first document in the page try { $result = $apiInstance->getResellerChilds($limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->getResellerChilds: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents for child accounts information per page | [optional] [default to 10] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] ### Return type [**\Brevo\Client\Model\GetChildrenList**](../Model/GetChildrenList.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **getSsoToken** > \Brevo\Client\Model\GetSsoToken getSsoToken($childIdentifier) Get session token to access Brevo (SSO) It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child try { $result = $apiInstance->getSsoToken($childIdentifier); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->getSsoToken: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | ### Return type [**\Brevo\Client\Model\GetSsoToken**](../Model/GetSsoToken.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **removeCredits** > \Brevo\Client\Model\RemainingCreditModel removeCredits($childIdentifier, $removeCredits) Remove Email and/or SMS credits from a specific child account ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $removeCredits = new \Brevo\Client\Model\RemoveCredits(); // \Brevo\Client\Model\RemoveCredits | Values to post to remove email or SMS credits from a specific child account try { $result = $apiInstance->removeCredits($childIdentifier, $removeCredits); print_r($result); } catch (Exception $e) { echo 'Exception when calling ResellerApi->removeCredits: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **removeCredits** | [**\Brevo\Client\Model\RemoveCredits**](../Model/RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account | ### Return type [**\Brevo\Client\Model\RemainingCreditModel**](../Model/RemainingCreditModel.md) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateChildAccountStatus** > updateChildAccountStatus($childIdentifier, $updateChildAccountStatus) Update info of reseller's child account status based on the childIdentifier supplied ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $updateChildAccountStatus = new \Brevo\Client\Model\UpdateChildAccountStatus(); // \Brevo\Client\Model\UpdateChildAccountStatus | values to update in child account status try { $apiInstance->updateChildAccountStatus($childIdentifier, $updateChildAccountStatus); } catch (Exception $e) { echo 'Exception when calling ResellerApi->updateChildAccountStatus: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **updateChildAccountStatus** | [**\Brevo\Client\Model\UpdateChildAccountStatus**](../Model/UpdateChildAccountStatus.md)| values to update in child account status | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateChildDomain** > updateChildDomain($childIdentifier, $domainName, $updateChildDomain) Update the sender domain of reseller's child based on the childIdentifier and domainName passed ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $domainName = "domainName_example"; // string | Pass the existing domain that needs to be updated $updateChildDomain = new \Brevo\Client\Model\UpdateChildDomain(); // \Brevo\Client\Model\UpdateChildDomain | value to update for sender domain try { $apiInstance->updateChildDomain($childIdentifier, $domainName, $updateChildDomain); } catch (Exception $e) { echo 'Exception when calling ResellerApi->updateChildDomain: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **domainName** | **string**| Pass the existing domain that needs to be updated | **updateChildDomain** | [**\Brevo\Client\Model\UpdateChildDomain**](../Model/UpdateChildDomain.md)| value to update for sender domain | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) # **updateResellerChild** > updateResellerChild($childIdentifier, $resellerChild) Update info of reseller's child based on the child identifier supplied ### Example ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\ResellerApi( // 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 ); $childIdentifier = "childIdentifier_example"; // string | Either auth key or id of reseller's child $resellerChild = new \Brevo\Client\Model\UpdateChild(); // \Brevo\Client\Model\UpdateChild | values to update in child profile try { $apiInstance->updateResellerChild($childIdentifier, $resellerChild); } catch (Exception $e) { echo 'Exception when calling ResellerApi->updateResellerChild: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **childIdentifier** | **string**| Either auth key or id of reseller's child | **resellerChild** | [**\Brevo\Client\Model\UpdateChild**](../Model/UpdateChild.md)| values to update in child profile | ### Return type void (empty response body) ### Authorization [api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[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) brevo-php/docs/Model/GetProcesses.md 0000644 00000000777 15021222673 0013401 0 ustar 00 # GetProcesses ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **processes** | [**\Brevo\Client\Model\GetProcess[]**](GetProcess.md) | List of processes available on your account | [optional] **count** | **int** | Number of processes available on your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateBatchProductsModel.md 0000644 00000000736 15021222673 0017003 0 ustar 00 # CreateUpdateBatchProductsModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdCount** | **int** | Number of the new created products | [optional] **updatedCount** | **int** | Number of the existing products updated | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactCampaignStatsOpened.md 0000644 00000001106 15021222673 0016623 0 ustar 00 # GetContactCampaignStatsOpened ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **count** | **int** | Number of openings of the campaign | **eventTime** | **string** | UTC date-time of the event | **ip** | **string** | IP from which the user has opened the campaign | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetList.md 0000644 00000001124 15021222673 0012331 0 ustar 00 # GetList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the list | **name** | **string** | Name of the list | **totalBlacklisted** | **int** | Number of blacklisted contacts in the list | **totalSubscribers** | **int** | Number of contacts in the list | **uniqueSubscribers** | **int** | Number of unique contacts in the list | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateList.md 0000644 00000001113 15021222673 0013032 0 ustar 00 # UpdateList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the list. Either of the two parameters (name, folderId) can be updated at a time. | [optional] **folderId** | **int** | Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailSender.md 0000644 00000001504 15021222673 0014626 0 ustar 00 # SendSmtpEmailSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. | [optional] **email** | **string** | Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. | [optional] **id** | **int** | Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CompanyAttributesInner.md 0000644 00000001040 15021222673 0015424 0 ustar 00 # CompanyAttributesInner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **internalName** | **string** | | [optional] **label** | **string** | | [optional] **attributeTypeName** | **string** | | [optional] **attributeOptions** | **object[]** | | [optional] **isRequired** | **bool** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendReport.md 0000644 00000000753 15021222673 0013052 0 ustar 00 # SendReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **language** | **string** | Language of email content for campaign report sending. | [optional] [default to 'fr'] **email** | [**\Brevo\Client\Model\SendReportEmail**](SendReportEmail.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/WhatsappCampTemplate.md 0000644 00000002155 15021222673 0015047 0 ustar 00 # WhatsappCampTemplate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | name of the template | [optional] **category** | **string** | description of the template | [optional] **language** | **string** | language of the template | [optional] **containsButton** | **bool** | | [optional] **displayHeader** | **bool** | | [optional] **headerType** | **string** | type of header | [optional] **components** | [**\Brevo\Client\Model\ComponentItems[]**](ComponentItems.md) | array of component item objects | [optional] **headerVariables** | [**\Brevo\Client\Model\VariablesItems[]**](VariablesItems.md) | array of variables item object | [optional] **bodyVariables** | [**\Brevo\Client\Model\VariablesItems[]**](VariablesItems.md) | array of variables item variables | [optional] **buttonType** | **string** | | [optional] **hideFooter** | **bool** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateCategories.md 0000644 00000001260 15021222673 0015333 0 ustar 00 # CreateUpdateCategories ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique Category ID as saved in the shop | **name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] **url** | **string** | URL to the category | [optional] **deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExternalFeedByUUID.md 0000644 00000002276 15021222673 0014757 0 ustar 00 # GetExternalFeedByUUID ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | ID of the feed | **name** | **string** | Name of the feed | **url** | **string** | URL of the feed | **authType** | **string** | Auth type of the feed: * `basic` * `token` * `noAuth` | **username** | **string** | Username for authType `basic` | [optional] **password** | **string** | Password for authType `basic` | [optional] **token** | **string** | Token for authType `token` | [optional] **headers** | [**\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | **maxRetries** | **int** | Maximum number of retries on the feed url | **cache** | **bool** | Toggle caching of feed url response | **createdAt** | [**\DateTime**] | Datetime on which the feed was created | **modifiedAt** | [**\DateTime**] | Datetime on which the feed was modified | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateSender.md 0000644 00000001175 15021222673 0013347 0 ustar 00 # UpdateSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | From Name to update the sender | [optional] **email** | **string** | From Email to update the sender | [optional] **ips** | [**\Brevo\Client\Model\CreateSenderIps[]**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetReportsReports.md 0000644 00000002205 15021222673 0014434 0 ustar 00 # GetReportsReports ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | [**\DateTime**] | Date of the statistics | **requests** | **int** | Number of requests for the date | **delivered** | **int** | Number of delivered emails for the date | **hardBounces** | **int** | Number of hardbounces for the date | **softBounces** | **int** | Number of softbounces for the date | **clicks** | **int** | Number of clicks for the date | **uniqueClicks** | **int** | Number of unique clicks for the date | **opens** | **int** | Number of openings for the date | **uniqueOpens** | **int** | Number of unique openings for the date | **spamReports** | **int** | Number of complaints (spam reports) for the date | **blocked** | **int** | Number of blocked emails for the date | **invalid** | **int** | Number of invalid emails for the date | **unsubscribed** | **int** | Number of unsubscribed emails for the date | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetScheduledEmailByMessageId.md 0000644 00000001036 15021222673 0016345 0 ustar 00 # GetScheduledEmailByMessageId ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **scheduledAt** | [**\DateTime**] | Datetime for which the email was scheduled | **createdAt** | [**\DateTime**] | Datetime on which the email was scheduled | **status** | **string** | Current status of the scheduled email | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsappCampaignsCampaigns.md 0000644 00000002400 15021222673 0016651 0 ustar 00 # GetWhatsappCampaignsCampaigns ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the WhatsApp Campaign | **campaignName** | **string** | Name of the WhatsApp Campaign | **templateId** | **string** | Id of the WhatsApp template | **campaignStatus** | **string** | Status of the WhatsApp Campaign | **scheduledAt** | **string** | UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | **errorReason** | **string** | Error reason in the campaign creation | [optional] **invalidatedContacts** | **int** | Count of invalidated contacts | [optional] **readPercentage** | **float** | Read percentage of the the WhatsApp campaign created | [optional] **stats** | [**\Brevo\Client\Model\WhatsappCampStats**](WhatsappCampStats.md) | | [optional] **createdAt** | **string** | Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the whatsapp template (YYYY-MM-DDTHH:mm:ss.SSSZ) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateWebhook.md 0000644 00000002407 15021222673 0013524 0 ustar 00 # UpdateWebhook ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | URL of the webhook | [optional] **description** | **string** | Description of the webhook | [optional] **events** | **string[]** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | [optional] **domain** | **string** | Inbound domain of webhook, used in case of event type `inbound` | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestVersionClicks.md 0000644 00000000462 15021222673 0014643 0 ustar 00 # AbTestVersionClicks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ConversationsmessageFileImageInfo.md 0000644 00000000757 15021222673 0017552 0 ustar 00 # ConversationsMessageFileImageInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **width** | **int** | Width of the image | [optional] **height** | **int** | height of the image | [optional] **previewUrl** | **string** | URL of the preview | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountUpdatePlanRequestFeatures.md 0000644 00000000764 15021222673 0020063 0 ustar 00 # SubAccountUpdatePlanRequestFeatures ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **users** | **int** | Number of multi-users | [optional] **landingPage** | **int** | Number of landing pages | [optional] **inbox** | **int** | Number of inboxes | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/EmailExportRecipients.md 0000644 00000001051 15021222673 0015234 0 ustar 00 # EmailExportRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **notifyURL** | **string** | Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] **recipientsType** | **string** | Type of recipients to export for a campaign | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSsoToken.md 0000644 00000000567 15021222673 0013175 0 ustar 00 # GetSsoToken ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **token** | **string** | Session token, it will remain valid for 15 days. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse2001.md 0000644 00000000742 15021222673 0014223 0 ustar 00 # InlineResponse2001 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The id of the collection | **name** | **string** | The name of the collection | **defaultCoupon** | **string** | The default coupon of the collection | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSegments.md 0000644 00000000741 15021222673 0013207 0 ustar 00 # GetSegments ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **segments** | [**\Brevo\Client\Model\GetSegmentsSegments**](GetSegmentsSegments.md) | | [optional] **count** | **int** | Number of Segments available in your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetScheduledEmailByBatchId.md 0000644 00000000767 15021222673 0016014 0 ustar 00 # GetScheduledEmailByBatchId ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Total number of batches | [optional] **batches** | [**\Brevo\Client\Model\GetScheduledEmailByBatchIdBatches[]**](GetScheduledEmailByBatchIdBatches.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateAttribute.md 0000644 00000001433 15021222673 0014067 0 ustar 00 # UpdateAttribute ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **string** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] **enumeration** | [**\Brevo\Client\Model\UpdateAttributeEnumeration[]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SsoTokenRequest.md 0000644 00000002102 15021222673 0014071 0 ustar 00 # SsoTokenRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Id of the sub-account organization | **email** | **string** | User email of sub-account organization | [optional] **target** | **string** | Set target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Contacts after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login | [optional] **url** | **string** | Set the full target URL after login success. The user will land directly on this target URL after login | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md 0000644 00000000721 15021222673 0022201 0 ustar 00 # SubAccountDetailsResponsePlanInfoFeaturesInbox ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **int** | Quantity of inbox provided | [optional] **remaining** | **int** | Available inboxes for use | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md 0000644 00000000760 15021222673 0027134 0 ustar 00 # GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **eventTime** | **string** | UTC date-time of the event | **ip** | **string** | IP from which the user has been unsubscribed | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetStatsByDomain.md 0000644 00000000457 15021222673 0014147 0 ustar 00 # GetStatsByDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactCampaignStatsClicked.md 0000644 00000001014 15021222673 0016745 0 ustar 00 # GetContactCampaignStatsClicked ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **links** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[]**](GetExtendedContactDetailsStatisticsLinks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsappCampaignOverview.md 0000644 00000002145 15021222673 0016400 0 ustar 00 # GetWhatsappCampaignOverview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the WhatsApp Campaign | **campaignName** | **string** | Name of the WhatsApp Campaign | **campaignStatus** | **string** | Status of the WhatsApp Campaign | **scheduledAt** | **string** | UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] **senderNumber** | **string** | Sender of the WhatsApp Campaign | **stats** | [**\Brevo\Client\Model\WhatsappCampStats**](WhatsappCampStats.md) | | [optional] **template** | [**\Brevo\Client\Model\WhatsappCampTemplate**](WhatsappCampTemplate.md) | | **createdAt** | **string** | Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetUserPermissionPrivileges.md 0000644 00000000576 15021222673 0016451 0 ustar 00 # GetUserPermissionPrivileges ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **feature** | **string** | | **permissions** | **string[]** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCategoryDetails.md 0000644 00000001454 15021222673 0014507 0 ustar 00 # GetCategoryDetails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Category ID for which you requested the details | **name** | **string** | Name of the category for which you requested the details | **createdAt** | **string** | Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) | **url** | **string** | URL to the category | [optional] **isDeleted** | **bool** | category deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse2014.md 0000644 00000000543 15021222673 0014226 0 ustar 00 # InlineResponse2014 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | ID of the object created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateEmailCampaign.md 0000644 00000014750 15021222673 0014602 0 ustar 00 # CreateEmailCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag** | **string** | Tag of the campaign | [optional] **sender** | [**\Brevo\Client\Model\CreateEmailCampaignSender**](CreateEmailCampaignSender.md) | | **name** | **string** | Name of the campaign | **htmlContent** | **string** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] **htmlUrl** | **string** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] **templateId** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] **scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] **subject** | **string** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional] **previewText** | **string** | Preview text or preheader of the email campaign | [optional] **replyTo** | **string** | Email on which the campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] **recipients** | [**\Brevo\Client\Model\CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional] **attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **inlineImageActivation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false] **mirrorActive** | **bool** | Use true to enable the mirror link | [optional] **footer** | **string** | Footer of the email campaign | [optional] **header** | **string** | Header of the email campaign | [optional] **utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] **params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to false] **abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false] **subjectA** | **string** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] **subjectB** | **string** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] **splitRule** | **int** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] **winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional] **winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional] **ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false] **initialQuota** | **int** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] **increaseRate** | **int** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional] **unsubscriptionPageId** | **string** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. | [optional] **updateFormId** | **string** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountUpdatePlanRequestCredits.md 0000644 00000000575 15021222673 0017702 0 ustar 00 # SubAccountUpdatePlanRequestCredits ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **int** | Number of email credits | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateDomainModelDnsRecordsDkimRecord.md 0000644 00000000745 15021222673 0020235 0 ustar 00 # CreateDomainModelDnsRecordsDkimRecord ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | | [optional] **value** | **string** | | [optional] **hostName** | **string** | | [optional] **status** | **bool** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsEventReport.md 0000644 00000000636 15021222673 0014365 0 ustar 00 # GetSmsEventReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**\Brevo\Client\Model\GetSmsEventReportEvents[]**](GetSmsEventReportEvents.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Order.md 0000644 00000002213 15021222673 0012031 0 ustar 00 # Order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique ID of the order. | **createdAt** | **string** | Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. | **updatedAt** | **string** | Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. | **status** | **string** | State of the order. | **amount** | **float** | Total amount of the order, including all shipping expenses, tax and the price of items. | **products** | [**\Brevo\Client\Model\OrderProducts[]**](OrderProducts.md) | | **email** | **string** | Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. | [optional] **billing** | [**\Brevo\Client\Model\OrderBilling**](OrderBilling.md) | | [optional] **coupons** | **string[]** | Coupons applied to the order. Stored case insensitive. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWATemplatesTemplates.md 0000644 00000001607 15021222673 0015471 0 ustar 00 # GetWATemplatesTemplates ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | id of the template | **name** | **string** | Name of the WhatsApp template | **status** | **string** | Status of the WhatsApp template | **language** | **string** | Language in which template exists | **category** | **string** | category of the template | **errorReason** | **string** | Error reason in the template creation | [optional] **createdAt** | **string** | Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSmtpEmail.md 0000644 00000000663 15021222673 0014004 0 ustar 00 # CreateSmtpEmail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **messageId** | **string** | Message ID of the transactional email sent | [optional] **messageIds** | **string[]** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestContactExportCustomContactFilter.md 0000644 00000005417 15021222673 0021012 0 ustar 00 # RequestContactExportCustomContactFilter ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **actionForContacts** | **string** | Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. | [optional] **actionForEmailCampaigns** | **string** | Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). | [optional] **actionForSmsCampaigns** | **string** | Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. | [optional] **listId** | **int** | Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. | [optional] **emailCampaignId** | **int** | Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. | [optional] **smsCampaignId** | **int** | Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfoApiKeysV3.md 0000644 00000000635 15021222673 0014762 0 ustar 00 # GetChildInfoApiKeysV3 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the key for version 3 | **key** | **string** | API Key for version 3 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateSmtpTemplate.md 0000644 00000003553 15021222673 0014550 0 ustar 00 # UpdateSmtpTemplate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag** | **string** | Tag of the template | [optional] **sender** | [**\Brevo\Client\Model\UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) | | [optional] **templateName** | **string** | Name of the template | [optional] **htmlContent** | **string** | Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) | [optional] **htmlUrl** | **string** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] **subject** | **string** | Subject of the email | [optional] **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] **attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **isActive** | **bool** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateCouponCollection.md 0000644 00000000754 15021222673 0015371 0 ustar 00 # CreateCouponCollection ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **object** | Name of the collection with no white spaces between words | **defaultCoupon** | **object** | A default coupon to be used in case there are no coupons left | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInboundEmailEventsByUuid.md 0000644 00000002504 15021222673 0016276 0 ustar 00 # GetInboundEmailEventsByUuid ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **receivedAt** | [**\DateTime**] | Date when email was received on SMTP relay | [optional] **deliveredAt** | [**\DateTime**] | Date when email was delivered successfully to client’s webhook | [optional] **recipient** | **string** | Recipient’s email address | [optional] **sender** | **string** | Sender’s email address | [optional] **messageId** | **string** | Value of the Message-ID header. This will be present only after the processing is done. | [optional] **subject** | **string** | Value of the Subject header. This will be present only after the processing is done. | [optional] **attachments** | [**\Brevo\Client\Model\GetInboundEmailEventsByUuidAttachments[]**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] **logs** | [**\Brevo\Client\Model\GetInboundEmailEventsByUuidLogs[]**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetStatsByBrowser.md 0000644 00000000460 15021222673 0014355 0 ustar 00 # GetStatsByBrowser ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountActivity.md 0000644 00000000661 15021222673 0014534 0 ustar 00 # GetAccountActivity ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **logs** | [**\Brevo\Client\Model\GetAccountActivityLogs[]**](GetAccountActivityLogs.md) | Get user activity logs | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Task.md 0000644 00000001337 15021222673 0011666 0 ustar 00 # Task ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique task id | [optional] **taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | **name** | **string** | Name of task | **contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] **dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] **companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Pipeline.md 0000644 00000001001 15021222673 0012515 0 ustar 00 # Pipeline ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pipeline** | **string** | Pipeline id | [optional] **pipelineName** | **string** | Pipeline Name | [optional] **stages** | [**\Brevo\Client\Model\PipelineStage[]**](PipelineStage.md) | List of stages | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body.md 0000644 00000002140 15021222673 0011652 0 ustar 00 # Body ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of task | **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | **date** | [**\DateTime**] | Task due date and time | **notes** | **string** | Notes added to a task | [optional] **done** | **bool** | Task marked as done | [optional] **assignToId** | **string** | User id to whom task is assigned | [optional] **contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] **dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] **companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] **reminder** | [**\Brevo\Client\Model\TaskReminder**](TaskReminder.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RemoveContactFromList.md 0000644 00000001733 15021222673 0015215 0 ustar 00 # RemoveContactFromList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emails** | **string[]** | Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. | [optional] **ids** | **int[]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] **all** | **bool** | Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailReplyTo1.md 0000644 00000000705 15021222673 0015067 0 ustar 00 # SendSmtpEmailReplyTo1 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address in reply to | **name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateWhatsAppTemplate.md 0000644 00000002057 15021222673 0015333 0 ustar 00 # CreateWhatsAppTemplate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the template | **language** | **string** | Language of the template. For Example : **en** for English | **category** | **string** | Category of the template | **mediaUrl** | **string** | Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty.** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf | [optional] **bodyText** | **string** | Body of the template. **Maximum allowed characters are 1024** | **headerText** | **string** | Text content of the header in the template. **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty** | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAttributes.md 0000644 00000000712 15021222673 0013546 0 ustar 00 # GetAttributes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**\Brevo\Client\Model\GetAttributesAttributes[]**](GetAttributesAttributes.md) | Listing of available contact attributes in your account | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatistics.md 0000644 00000003777 15021222673 0020073 0 ustar 00 # GetExtendedContactDetailsStatistics ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **messagesSent** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the sent campaign for the contact | [optional] **hardBounces** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the hardbounes generated by the contact | [optional] **softBounces** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the softbounes generated by the contact | [optional] **complaints** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the complaints generated by the contact | [optional] **unsubscriptions** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptions**](GetExtendedContactDetailsStatisticsUnsubscriptions.md) | | [optional] **opened** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsOpened[]**](GetExtendedContactDetailsStatisticsOpened.md) | Listing of the openings generated by the contact | [optional] **clicked** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsClicked[]**](GetExtendedContactDetailsStatisticsClicked.md) | Listing of the clicks generated by the contact | [optional] **transacAttributes** | **object[]** | Listing of the transactional attributes for the contact | [optional] **delivered** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | Listing of the delivered campaign for the contact | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateFolder.md 0000644 00000000552 15021222673 0014464 0 ustar 00 # CreateUpdateFolder ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the folder | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCampaignRecipients.md 0000644 00000000565 15021222673 0015173 0 ustar 00 # GetCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **lists** | **int[]** | | **exclusionLists** | **int[]** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendReportEmail.md 0000644 00000000677 15021222673 0014027 0 ustar 00 # SendReportEmail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **to** | **string[]** | Email addresses of the recipients | **body** | **string** | Custom text message to be presented in the report email. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacEmailsListTransactionalEmails.md 0000644 00000001602 15021222673 0020657 0 ustar 00 # GetTransacEmailsListTransactionalEmails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address to which transactional email has been sent | **subject** | **string** | Subject of the sent email | **templateId** | **int** | Id of the template | [optional] **messageId** | **string** | Message Id of the sent email | **uuid** | **string** | Unique id of the email sent to a particular contact | **date** | **string** | Date on which transactional email was sent | **from** | **string** | Email address of the sender from which the email was sent | [optional] **tags** | **string[]** | Tags used for your email | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestContactImportJsonBody.md 0000644 00000000661 15021222673 0016572 0 ustar 00 # RequestContactImportJsonBody ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | | [optional] **attributes** | **object** | List of attributes to be imported | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateSmtpTemplateSender.md 0000644 00000001171 15021222673 0015703 0 ustar 00 # UpdateSmtpTemplateSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the sender | [optional] **email** | **string** | Email of the sender | [optional] **id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateCouponCollection.md 0000644 00000000627 15021222673 0015407 0 ustar 00 # UpdateCouponCollection ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **defaultCoupon** | **string** | A default coupon to be used in case there are no coupons left | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AddContactToList.md 0000644 00000001464 15021222673 0014130 0 ustar 00 # AddContactToList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emails** | **string[]** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] **ids** | **int[]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/OrderBatch.md 0000644 00000000752 15021222673 0013001 0 ustar 00 # OrderBatch ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orders** | [**\Brevo\Client\Model\Order[]**](Order.md) | array of order objects | **notifyUrl** | **string** | Notify Url provided by client to get the status of batch request | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetStatsByDevice.md 0000644 00000001747 15021222673 0014142 0 ustar 00 # GetStatsByDevice ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **desktop** | [**map[string,\Brevo\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] **mobile** | [**map[string,\Brevo\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] **tablet** | [**map[string,\Brevo\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] **unknown** | [**map[string,\Brevo\Client\Model\GetDeviceBrowserStats]**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/TaskList.md 0000644 00000000573 15021222673 0012523 0 ustar 00 # TaskList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **items** | [**\Brevo\Client\Model\Task[]**](Task.md) | List of tasks | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateBatchProducts.md 0000644 00000001072 15021222673 0016014 0 ustar 00 # CreateUpdateBatchProducts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **products** | [**\Brevo\Client\Model\CreateUpdateProducts[]**](CreateUpdateProducts.md) | array of products objects | **updateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Company.md 0000644 00000001152 15021222673 0012365 0 ustar 00 # Company ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique company id | [optional] **attributes** | **object** | Company attributes with values | [optional] **linkedContactsIds** | **int[]** | Contact ids for contacts linked to this company | [optional] **linkedDealsIds** | **string[]** | Deals ids for companies linked to this company | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetDeviceBrowserStats.md 0000644 00000001275 15021222673 0015207 0 ustar 00 # GetDeviceBrowserStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **clickers** | **int** | Number of total clicks for the campaign using the particular browser | **uniqueClicks** | **int** | Number of unique clicks for the campaign using the particular browser | **viewed** | **int** | Number of openings for the campaign using the particular browser | **uniqueViews** | **int** | Number of unique openings for the campaign using the particular browser | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateWhatsAppCampaign.md 0000644 00000001646 15021222673 0015321 0 ustar 00 # UpdateWhatsAppCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignName** | **string** | Name of the campaign | [optional] **campaignStatus** | **string** | Status of the campaign | [optional] [default to 'scheduled'] **rescheduleFor** | **string** | Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign. | [optional] **recipients** | [**\Brevo\Client\Model\CreateWhatsAppCampaignRecipients**](CreateWhatsAppCampaignRecipients.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetIp.md 0000644 00000001004 15021222673 0011763 0 ustar 00 # GetIp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the dedicated IP | **ip** | **string** | Dedicated IP | **active** | **bool** | Status of the IP (true=active, false=inactive) | **domain** | **string** | Domain associated to the IP | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body8.md 0000644 00000002635 15021222673 0011753 0 ustar 00 # Body8 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **visitorId** | **string** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> | **text** | **string** | message text | **agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] **receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional] **agentEmail** | **string** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional] **agentName** | **string** | agent name | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestVersionStats.md 0000644 00000000671 15021222673 0014533 0 ustar 00 # AbTestVersionStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **versionA** | **string** | percentage of an event for version A | **versionB** | **string** | percentage of an event for version B | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md 0000644 00000000724 15021222673 0022402 0 ustar 00 # GetExtendedContactDetailsStatisticsMessagesSent ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **eventTime** | **string** | UTC date-time of the event | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateCategoryModel.md 0000644 00000000605 15021222673 0014643 0 ustar 00 # CreateCategoryModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the category when a new category is created | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateWebhook.md 0000644 00000002513 15021222673 0013503 0 ustar 00 # CreateWebhook ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | URL of the webhook | **description** | **string** | Description of the webhook | [optional] **events** | **string[]** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | **type** | **string** | Type of the webhook | [optional] [default to 'transactional'] **domain** | **string** | Inbound domain of webhook, required in case of event type `inbound` | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Contact.md 0000644 00000001537 15021222673 0012361 0 ustar 00 # Contact ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **virtualNextTask** | **object** | Next incomplete task of contact | [optional] **email** | **string** | Contact email | **assignToId** | **string** | User id to whom contact is assigned | [optional] **contactsId** | **int** | Contact id | [optional] **crmLists** | **object** | CRM lists in which contact is added | **attributes** | **object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional] **createdAt** | [**\DateTime**] | Contact created date/time | [optional] **updatedAt** | [**\DateTime**] | Contact updated date/time | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetDomainsList.md 0000644 00000000705 15021222673 0013650 0 ustar 00 # GetDomainsList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domains** | [**\Brevo\Client\Model\GetDomainsListDomains[]**](GetDomainsListDomains.md) | List of the domains available in your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body12.md 0000644 00000002244 15021222673 0012022 0 ustar 00 # Body12 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional] **receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional] **agentEmail** | **string** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. | [optional] **agentName** | **string** | agent name. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateSmsCampaign.md 0000644 00000003552 15021222673 0014332 0 ustar 00 # UpdateSmsCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the campaign | [optional] **sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | [optional] **content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] **recipients** | [**\Brevo\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] **scheduledAt** | **string** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] **organisationPrefix** | **string** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] **unsubscribeInstruction** | **string** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/TaskReminder.md 0000644 00000000777 15021222673 0013363 0 ustar 00 # TaskReminder ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **int** | Value of time unit before reminder is to be sent | **unit** | **string** | Unit of time before reminder is to be sent | **types** | **string[]** | Type of task reminder e.g email, push | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateDomainModelDnsRecords.md 0000644 00000001121 15021222673 0016256 0 ustar 00 # CreateDomainModelDnsRecords ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dkimRecord** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional] **brevoCode** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestSmsRecipientExport.md 0000644 00000001117 15021222673 0016140 0 ustar 00 # RequestSmsRecipientExport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **notifyURL** | **string** | URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] **recipientsType** | **string** | Filter the recipients based on how they interacted with the campaign | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsCampaignStats.md 0000644 00000001264 15021222673 0014644 0 ustar 00 # GetSmsCampaignStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **delivered** | **int** | Number of delivered SMS | **sent** | **int** | Number of sent SMS | **processing** | **int** | Number of processing SMS | **softBounces** | **int** | Number of softbounced SMS | **hardBounces** | **int** | Number of hardbounced SMS | **unsubscriptions** | **int** | Number of unsubscription SMS | **answered** | **int** | Number of replies to the SMS | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfo.md 0000644 00000001234 15021222673 0017502 0 ustar 00 # SubAccountDetailsResponsePlanInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **credits** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) | | [optional] **features** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) | | [optional] **planType** | **string** | type of the plan | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWebhook.md 0000644 00000001357 15021222673 0013024 0 ustar 00 # GetWebhook ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | URL of the webhook | **id** | **int** | ID of the webhook | **description** | **string** | Description of the webhook | **events** | **string[]** | | **type** | **string** | Type of webhook (marketing or transactional) | **createdAt** | **string** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSmsCampaign.md 0000644 00000003511 15021222673 0014306 0 ustar 00 # CreateSmsCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the campaign | **sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | **content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | **recipients** | [**\Brevo\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] **scheduledAt** | **string** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] **organisationPrefix** | **string** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] **unsubscribeInstruction** | **string** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetProductDetails.md 0000644 00000003066 15021222673 0014353 0 ustar 00 # GetProductDetails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Product ID for which you requested the details | **name** | **string** | Name of the product for which you requested the details | **createdAt** | **string** | Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | **url** | **string** | URL to the product | [optional] **imageUrl** | **string** | Absolute URL to the cover image of the product | [optional] **sku** | **string** | Product identifier from the shop | [optional] **price** | **float** | Price of the product | [optional] **categories** | **string[]** | Category ID-s of the product | [optional] **parentId** | **string** | Parent product id of the product | [optional] **s3Original** | **string** | S3 url of original image | [optional] **s3ThumbAnalytics** | **string** | S3 thumbnail url of original image in 120x120 dimension for analytics section | **metaInfo** | **object** | Meta data of product such as description, vendor, producer, stock level, etc. | [optional] **s3ThumbEditor** | **string** | S3 thumbnail url of original image in 600x400 dimension for editor section | **isDeleted** | **bool** | product deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/PipelineStage.md 0000644 00000000612 15021222673 0013510 0 ustar 00 # PipelineStage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Stage id | [optional] **name** | **string** | Stage name | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body11.md 0000644 00000000524 15021222673 0012020 0 ustar 00 # Body11 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **text** | **string** | edited message text | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Pipelines.md 0000644 00000000450 15021222673 0012707 0 ustar 00 # Pipelines ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UploadImageModel.md 0000644 00000000543 15021222673 0014132 0 ustar 00 # UploadImageModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | URL of the image uploaded | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body3.md 0000644 00000001234 15021222673 0011740 0 ustar 00 # Body3 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of deal | **attributes** | **object** | Attributes for deal creation If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateWhatsAppCampaignRecipients.md 0000644 00000001176 15021222673 0017326 0 ustar 00 # CreateWhatsAppCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **excludedListIds** | **int[]** | List ids to exclude from the campaign | [optional] **listIds** | **int[]** | **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to | [optional] **segments** | **int[]** | **Mandatory if listIds are not used**. Segment ids to send the campaign to. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccount.md 0000644 00000001165 15021222673 0013017 0 ustar 00 # GetAccount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **plan** | [**\Brevo\Client\Model\GetAccountPlan[]**](GetAccountPlan.md) | Information about your plans and credits | **relay** | [**\Brevo\Client\Model\GetAccountRelay**](GetAccountRelay.md) | | **marketingAutomation** | [**\Brevo\Client\Model\GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacSmsReportReports.md 0000644 00000002060 15021222673 0016247 0 ustar 00 # GetTransacSmsReportReports ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | [**\DateTime**] | Date for which statistics are retrieved | [optional] **requests** | **int** | Number of requests for the date | [optional] **delivered** | **int** | Number of delivered SMS for the date | [optional] **hardBounces** | **int** | Number of hardbounces for the date | [optional] **softBounces** | **int** | Number of softbounces for the date | [optional] **blocked** | **int** | Number of blocked contact for the date | [optional] **unsubscribed** | **int** | Number of unsubscription for the date | [optional] **replied** | **int** | Number of answered SMS for the date | [optional] **accepted** | **int** | Number of accepted for the date | [optional] **rejected** | **int** | Number of rejected for the date | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UploadImageToGallery.md 0000644 00000001037 15021222673 0014773 0 ustar 00 # UploadImageToGallery ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **imageUrl** | **string** | The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. | **name** | **string** | Name of the image. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateList.md 0000644 00000000655 15021222673 0013025 0 ustar 00 # CreateList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the list | **folderId** | **int** | Id of the parent folder in which this list is to be created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetLists.md 0000644 00000000707 15021222673 0012522 0 ustar 00 # GetLists ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **lists** | **object[]** | Listing of all the lists available in your account | [optional] **count** | **int** | Number of lists in your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSharedTemplateUrl.md 0000644 00000000701 15021222673 0015003 0 ustar 00 # GetSharedTemplateUrl ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sharedUrl** | **string** | A unique URL for the email campaign or transactional template. This URL can be shared with other Brevo users. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildDomains.md 0000644 00000000456 15021222673 0013763 0 ustar 00 # GetChildDomains ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInboundEmailEventsEvents.md 0000644 00000001101 15021222673 0016331 0 ustar 00 # GetInboundEmailEventsEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **string** | UUID that can be used to fetch additional data | **date** | [**\DateTime**] | Date when email was received on SMTP relay | **sender** | **string** | Sender’s email address | **recipient** | **string** | Recipient’s email address | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetDomainConfigurationModel.md 0000644 00000001256 15021222673 0016344 0 ustar 00 # GetDomainConfigurationModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domain** | **string** | Domain | **verified** | **bool** | Status of domain verification (true=verified, false=non verified) | **authenticated** | **bool** | Status of domain authentication (true=authenticated, false=non authenticated) | **dnsRecords** | [**\Brevo\Client\Model\CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetScheduledEmailByBatchIdBatches.md 0000644 00000001043 15021222673 0017272 0 ustar 00 # GetScheduledEmailByBatchIdBatches ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **scheduledAt** | [**\DateTime**] | Datetime for which the batch was scheduled | **createdAt** | [**\DateTime**] | Datetime on which the batch was scheduled | **status** | **string** | Current status of the scheduled batch | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse2012.md 0000644 00000000553 15021222673 0014225 0 ustar 00 # InlineResponse2012 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The id of the created collection | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildAccountCreationStatus.md 0000644 00000000671 15021222673 0016655 0 ustar 00 # GetChildAccountCreationStatus ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **childAccountCreated** | **bool** | Status of child account creation whether it is successfully created (exists) or not. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/FileData.md 0000644 00000001740 15021222673 0012433 0 ustar 00 # FileData ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | Url of uploaded file | [optional] **id** | **string** | Id of uploaded file | [optional] **name** | **string** | Name of uploaded file | [optional] **authorId** | **string** | Account id of user which created the file | [optional] **author** | **object** | Account details of user which created the file | [optional] **contactId** | **int** | Contact id of contact on which file is uploaded | [optional] **dealId** | **string** | Deal id linked to a file | [optional] **companyId** | **string** | Company id linked to a file | [optional] **size** | **int** | Size of file in bytes | [optional] **createdAt** | [**\DateTime**] | File created date/time | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RemainingCreditModelReseller.md 0000644 00000000711 15021222673 0016502 0 ustar 00 # RemainingCreditModelReseller ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sms** | **double** | SMS Credits remaining for reseller account | **email** | **double** | Email Credits remaining for reseller account | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedCampaignOverviewSender.md 0000644 00000001001 15021222673 0017500 0 ustar 00 # GetExtendedCampaignOverviewSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Sender name of the campaign | [optional] **email** | **string** | Sender email of the campaign | [optional] **id** | **int** | Sender id of the campaign | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestCampaignResultStatistics.md 0000644 00000001534 15021222673 0017057 0 ustar 00 # AbTestCampaignResultStatistics ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **openers** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | **clicks** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | **unsubscribed** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | **hardBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | **softBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | **complaints** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetIpsFromSender.md 0000644 00000000641 15021222673 0014141 0 ustar 00 # GetIpsFromSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ips** | [**\Brevo\Client\Model\GetIpFromSender[]**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateCoupons.md 0000644 00000000666 15021222673 0013542 0 ustar 00 # CreateCoupons ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **collectionId** | **string** | The id of the coupon collection for which the coupons will be created | **coupons** | **string[]** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactCampaignStatsUnsubscriptions.md 0000644 00000001517 15021222673 0020631 0 ustar 00 # GetContactCampaignStatsUnsubscriptions ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userUnsubscription** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | **adminUnsubscription** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetClient.md 0000644 00000000732 15021222673 0012640 0 ustar 00 # GetClient ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Login Email | **firstName** | **string** | First Name | **lastName** | **string** | Last Name | **companyName** | **string** | Name of the company | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body7.md 0000644 00000002042 15021222673 0011742 0 ustar 00 # Body7 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of task | [optional] **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | [optional] **date** | [**\DateTime**] | Task date/time | [optional] **notes** | **string** | Notes added to a task | [optional] **done** | **bool** | Task marked as done | [optional] **assignToId** | **string** | User id to whom task is assigned | [optional] **contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] **dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] **companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacAggregatedSmsReport.md 0000644 00000002115 15021222673 0016644 0 ustar 00 # GetTransacAggregatedSmsReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **range** | **string** | Time frame of the report | [optional] **requests** | **int** | Number of requests for the timeframe | [optional] **delivered** | **int** | Number of delivered SMS for the timeframe | [optional] **hardBounces** | **int** | Number of hardbounces for the timeframe | [optional] **softBounces** | **int** | Number of softbounces for the timeframe | [optional] **blocked** | **int** | Number of blocked contact for the timeframe | [optional] **unsubscribed** | **int** | Number of unsubscription for the timeframe | [optional] **replied** | **int** | Number of answered SMS for the timeframe | [optional] **accepted** | **int** | Number of accepted for the timeframe | [optional] **rejected** | **int** | Number of rejected for the timeframe | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetEmailCampaigns.md 0000644 00000000646 15021222673 0014300 0 ustar 00 # GetEmailCampaigns ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaigns** | **object[]** | | [optional] **count** | **int** | Number of Email campaigns retrieved | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetUserPermission.md 0000644 00000001076 15021222673 0014413 0 ustar 00 # GetUserPermission ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the user. | **status** | **string** | Status of the invited user. | **privileges** | [**\Brevo\Client\Model\GetUserPermissionPrivileges[]**](GetUserPermissionPrivileges.md) | Granular feature permissions given to the user. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetIps.md 0000644 00000000612 15021222673 0012152 0 ustar 00 # GetIps ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ips** | [**\Brevo\Client\Model\GetIp[]**](GetIp.md) | Dedicated IP(s) available on your account | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateChild.md 0000644 00000001353 15021222673 0013131 0 ustar 00 # CreateChild ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address to create the child account | **firstName** | **string** | First name to use to create the child account | **lastName** | **string** | Last name to use to create the child account | **companyName** | **string** | Company name to use to create the child account | **password** | **string** | Password for the child account to login | **language** | **string** | Language of the child account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendWhatsappMessage.md 0000644 00000001245 15021222673 0014670 0 ustar 00 # SendWhatsappMessage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **templateId** | **int** | ID of the template to send | [optional] **text** | **string** | Text to be sent as message body (will be overridden if templateId is passed in the same request) | [optional] **senderNumber** | **string** | WhatsApp Number with country code. Example, 85264318721 | **contactNumbers** | **string[]** | List of phone numbers of the contacts | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body4.md 0000644 00000001213 15021222673 0011736 0 ustar 00 # Body4 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of deal | [optional] **attributes** | **object** | Attributes for deal update If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/FileDownloadableLink.md 0000644 00000000577 15021222673 0015002 0 ustar 00 # FileDownloadableLink ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fileUrl** | **string** | A unique link to download the requested file. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateModel.md 0000644 00000000531 15021222673 0013143 0 ustar 00 # CreateModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the object created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateEmailCampaignRecipients.md 0000644 00000001515 15021222673 0016642 0 ustar 00 # UpdateEmailCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional] **listIds** | **int[]** | Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] **segmentIds** | **int[]** | Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateDomain.md 0000644 00000000522 15021222673 0013312 0 ustar 00 # CreateDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Domain name | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacBlockedContactsReason.md 0000644 00000001046 15021222673 0017147 0 ustar 00 # GetTransacBlockedContactsReason ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional] **message** | **string** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreatedProcessId.md 0000644 00000000546 15021222673 0014150 0 ustar 00 # CreatedProcessId ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **processId** | **int** | Id of the process created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md 0000644 00000000745 15021222673 0023301 0 ustar 00 # SubAccountDetailsResponsePlanInfoFeaturesLandingPage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **int** | Quantity of landing pages provided | [optional] **remaining** | **int** | Available landing pages for use | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountActivityLogs.md 0000644 00000001270 15021222673 0015356 0 ustar 00 # GetAccountActivityLogs ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **action** | **string** | Type of activity in the account. | **date** | **string** | Time of the activity. | **userEmail** | **string** | Email address of the user who performed activity in the account. | **userIp** | **string** | IP address of the user who performed activity in the account. | **userAgent** | **string** | Browser details of the user who performed the activity. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RemainingCreditModel.md 0000644 00000001004 15021222673 0015000 0 ustar 00 # RemainingCreditModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **child** | [**\Brevo\Client\Model\RemainingCreditModelChild**](RemainingCreditModelChild.md) | | **reseller** | [**\Brevo\Client\Model\RemainingCreditModelReseller**](RemainingCreditModelReseller.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/NoteData.md 0000644 00000001061 15021222673 0012455 0 ustar 00 # NoteData ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **text** | **string** | Text content of a note | **contactIds** | **int[]** | Contact Ids linked to a note | [optional] **dealIds** | **string[]** | Deal Ids linked to a note | [optional] **companyIds** | **string[]** | Company Ids linked to a note | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInboundEmailEventsByUuidLogs.md 0000644 00000000663 15021222673 0017127 0 ustar 00 # GetInboundEmailEventsByUuidLogs ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | [**\DateTime**] | Date of the event | [optional] **type** | **string** | Type of the event | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateAttribute.md 0000644 00000002634 15021222673 0014054 0 ustar 00 # CreateAttribute ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **string** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] **isRecurring** | **bool** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] **enumeration** | [**\Brevo\Client\Model\CreateAttributeEnumeration[]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] **type** | **string** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountsResponse.md 0000644 00000000763 15021222673 0014736 0 ustar 00 # SubAccountsResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Total number of subaccounts | [optional] **subAccounts** | [**\Brevo\Client\Model\SubAccountsResponseSubAccounts[]**](SubAccountsResponseSubAccounts.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateChild.md 0000644 00000001356 15021222673 0013153 0 ustar 00 # UpdateChild ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | New Email address to update the child account | [optional] **firstName** | **string** | New First name to use to update the child account | [optional] **lastName** | **string** | New Last name to use to update the child account | [optional] **companyName** | **string** | New Company name to use to update the child account | [optional] **password** | **string** | New password for the child account to login | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/VariablesItems.md 0000644 00000000651 15021222673 0013674 0 ustar 00 # VariablesItems ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | | [optional] **default** | **string** | | [optional] **datatype** | **string** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse200.md 0000644 00000000533 15021222673 0014140 0 ustar 00 # InlineResponse200 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique company id | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateWhatsAppCampaign.md 0000644 00000001404 15021222673 0015272 0 ustar 00 # CreateWhatsAppCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the WhatsApp campaign creation | **templateId** | **int** | Id of the WhatsApp template in **approved** state | **scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** | **recipients** | [**\Brevo\Client\Model\CreateWhatsAppCampaignRecipients**](CreateWhatsAppCampaignRecipients.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetReports.md 0000644 00000000614 15021222673 0013057 0 ustar 00 # GetReports ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reports** | [**\Brevo\Client\Model\GetReportsReports[]**](GetReportsReports.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountsResponseSubAccounts.md 0000644 00000001067 15021222673 0017106 0 ustar 00 # SubAccountsResponseSubAccounts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | id of the sub-account | **companyName** | **string** | Name of the sub-account company | **active** | **bool** | Whether the sub-account is active or not | **createdAt** | **int** | Timestamp when the sub-account was created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmtpTemplates.md 0000644 00000000753 15021222673 0014227 0 ustar 00 # GetSmtpTemplates ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Count of transactional email templates | [optional] **templates** | [**\Brevo\Client\Model\GetSmtpTemplateOverview[]**](GetSmtpTemplateOverview.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsAppConfig.md 0000644 00000002015 15021222673 0014273 0 ustar 00 # GetWhatsAppConfig ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **whatsappBusinessAccountId** | **string** | Id of the WhatsApp business account | [optional] **sendingLimit** | **string** | Sending limit Information of the WhatsApp API account | [optional] **phoneNumberQuality** | **string** | Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - **High (GREEN) , Medium (YELLOW) and Low(RED)** | [optional] **whatsappBusinessAccountStatus** | **string** | Status information related to WhatsApp Api account | [optional] **businessStatus** | **string** | Verification status information of the Business account | [optional] **phoneNumberNameStatus** | **string** | Status of the name associated with WhatsApp Phone number | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/PostSendSmsTestFailed.md 0000644 00000000756 15021222673 0015157 0 ustar 00 # PostSendSmsTestFailed ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **int** | Response code | **message** | **string** | Response message | **unexistingSms** | **string[]** | | [optional] **withoutListSms** | **string[]** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md 0000644 00000000761 15021222673 0022157 0 ustar 00 # SubAccountDetailsResponsePlanInfoCreditsEmails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **int** | Quantity of email messaging limits provided | [optional] **remaining** | **int** | Available email messaging limits for use | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailAttachment.md 0000644 00000001121 15021222673 0015471 0 ustar 00 # SendSmtpEmailAttachment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **url** | **string** | Absolute url of the attachment (no local file). | [optional] **content** | **string** | Base64 encoded chunk data of the attachment generated on the fly | [optional] **name** | **string** | Required if content is passed. Name of the attachment | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateBatchContactsContacts.md 0000644 00000004134 15021222673 0016344 0 ustar 00 # UpdateBatchContactsContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] **id** | **int** | id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] **sms** | **string** | SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) | [optional] **extId** | **string** | Pass your own Id to update ext_id of a contact. | [optional] **attributes** | **map[string,object]** | Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** | [optional] **emailBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] **smsBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] **listIds** | **int[]** | Ids of the lists to add the contact to | [optional] **unlinkListIds** | **int[]** | Ids of the lists to remove the contact from | [optional] **smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md 0000644 00000001445 15021222673 0021205 0 ustar 00 # SubAccountDetailsResponsePlanInfoFeatures ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **inbox** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) | | [optional] **landingPage** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) | | [optional] **users** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetFolders.md 0000644 00000000645 15021222673 0013023 0 ustar 00 # GetFolders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **folders** | **object[]** | | [optional] **count** | **int** | Number of folders available in your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAttributesAttributes.md 0000644 00000001337 15021222673 0015621 0 ustar 00 # GetAttributesAttributes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the attribute | **category** | **string** | Category of the attribute | **type** | **string** | Type of the attribute | [optional] **enumeration** | [**\Brevo\Client\Model\GetAttributesEnumeration[]**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] **calculatedValue** | **string** | Calculated value formula | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestContactExport.md 0000644 00000001527 15021222673 0015133 0 ustar 00 # RequestContactExport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **exportAttributes** | **string[]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] **customContactFilter** | [**\Brevo\Client\Model\RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) | | **notifyUrl** | **string** | Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAllExternalFeeds.md 0000644 00000000735 15021222673 0014607 0 ustar 00 # GetAllExternalFeeds ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Total number of batches | [optional] **feeds** | [**\Brevo\Client\Model\GetAllExternalFeedsFeeds[]**](GetAllExternalFeedsFeeds.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/PostContactInfo.md 0000644 00000000621 15021222673 0014034 0 ustar 00 # PostContactInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contacts** | [**\Brevo\Client\Model\PostContactInfoContacts**](PostContactInfoContacts.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailMessageVersions.md 0000644 00000002454 15021222673 0016530 0 ustar 00 # SendSmtpEmailMessageVersions ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **to** | [**\Brevo\Client\Model\SendSmtpEmailTo1[]**](SendSmtpEmailTo1.md) | List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | **params** | **map[string,object]** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] **bcc** | [**\Brevo\Client\Model\SendSmtpEmailBcc[]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] **cc** | [**\Brevo\Client\Model\SendSmtpEmailCc[]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] **replyTo** | [**\Brevo\Client\Model\SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional] **subject** | **string** | Custom subject specific to message version | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCampaignStats.md 0000644 00000003325 15021222673 0014161 0 ustar 00 # GetCampaignStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **listId** | **int** | List Id of email campaign (only in case of get email campaign(s)(not for global stats)) | [optional] **uniqueClicks** | **int** | Number of unique clicks for the campaign | **clickers** | **int** | Number of total clicks for the campaign | **complaints** | **int** | Number of complaints (Spam reports) for the campaign | **delivered** | **int** | Number of delivered emails for the campaign | **sent** | **int** | Number of sent emails for the campaign | **softBounces** | **int** | Number of softbounce for the campaign | **hardBounces** | **int** | Number of harbounce for the campaign | **uniqueViews** | **int** | Number of unique openings for the campaign | **trackableViews** | **int** | Recipients without any privacy protection option enabled in their email client | **trackableViewsRate** | **float** | Rate of recipients without any privacy protection option enabled in their email client | [optional] **estimatedViews** | **int** | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | [optional] **unsubscriptions** | **int** | Number of unsubscription for the campaign | **viewed** | **int** | Number of openings for the campaign | **deferred** | **int** | Number of deferred emails for the campaign | [optional] **returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCategories.md 0000644 00000000576 15021222673 0013515 0 ustar 00 # GetCategories ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **categories** | **object[]** | | **count** | **int** | Number of categories | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateDomainModel.md 0000644 00000001103 15021222673 0014267 0 ustar 00 # CreateDomainModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the Domain created | **domainName** | **string** | Domain | [optional] **message** | **string** | Success message | [optional] **dnsRecords** | [**\Brevo\Client\Model\CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendTestEmail.md 0000644 00000001041 15021222673 0013455 0 ustar 00 # SendTestEmail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emailTo** | **string[]** | List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContacts.md 0000644 00000000570 15021222673 0013200 0 ustar 00 # GetContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contacts** | **object[]** | | **count** | **int** | Number of contacts | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAllExternalFeedsFeeds.md 0000644 00000002301 15021222673 0015545 0 ustar 00 # GetAllExternalFeedsFeeds ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | ID of the feed | **name** | **string** | Name of the feed | **url** | **string** | URL of the feed | **authType** | **string** | Auth type of the feed: * `basic` * `token` * `noAuth` | **username** | **string** | Username for authType `basic` | [optional] **password** | **string** | Password for authType `basic` | [optional] **token** | **string** | Token for authType `token` | [optional] **headers** | [**\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | **maxRetries** | **int** | Maximum number of retries on the feed url | **cache** | **bool** | Toggle caching of feed url response | **createdAt** | [**\DateTime**] | Datetime on which the feed was created | **modifiedAt** | [**\DateTime**] | Datetime on which the feed was modified | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsCampaignOverview.md 0000644 00000001645 15021222673 0015357 0 ustar 00 # GetSmsCampaignOverview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the SMS Campaign | **name** | **string** | Name of the SMS Campaign | **status** | **string** | Status of the SMS Campaign | **content** | **string** | Content of the SMS Campaign | **scheduledAt** | **string** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] **sender** | **string** | Sender of the SMS Campaign | **createdAt** | **string** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md 0000644 00000001065 15021222673 0027021 0 ustar 00 # GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **eventTime** | **string** | UTC date-time of the event | **ip** | **string** | IP from which the user has unsubscribed | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetDomainsListDomains.md 0000644 00000001263 15021222673 0015163 0 ustar 00 # GetDomainsListDomains ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Id of the domain | **domainName** | **string** | Domain name | **authenticated** | **bool** | Status of domain authentication (true=authenticated, false=non authenticated) | **verified** | **bool** | Status of domain verification (true=verified, false=non verified) | **ip** | **string** | Dedicated IP associated with domain | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSubAccount.md 0000644 00000001124 15021222673 0014150 0 ustar 00 # CreateSubAccount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **companyName** | **string** | Set the name of the sub-account company | **email** | **string** | Email address for the organization | **language** | **string** | Set the language of the sub-account | [optional] **timezone** | **string** | Set the timezone of the sub-account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateChildAccountStatus.md 0000644 00000001637 15021222673 0015676 0 ustar 00 # UpdateChildAccountStatus ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionalEmail** | **bool** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] **transactionalSms** | **bool** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] **marketingAutomation** | **bool** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] **smsCampaign** | **bool** | Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfo.md 0000644 00000001372 15021222673 0013262 0 ustar 00 # GetChildInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **credits** | [**\Brevo\Client\Model\GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional] **statistics** | [**\Brevo\Client\Model\GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional] **password** | **string** | The encrypted password of child account | **ips** | **string[]** | IP(s) associated to a child account user | [optional] **apiKeys** | [**\Brevo\Client\Model\GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildrenList.md 0000644 00000000677 15021222673 0014016 0 ustar 00 # GetChildrenList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **children** | **object[]** | Your children's account information | [optional] **count** | **int** | Number of child accounts | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSmtpTemplate.md 0000644 00000003315 15021222673 0014525 0 ustar 00 # CreateSmtpTemplate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag** | **string** | Tag of the template | [optional] **sender** | [**\Brevo\Client\Model\CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) | | **templateName** | **string** | Name of the template | **htmlContent** | **string** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional] **htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] **subject** | **string** | Subject of the template | **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] **attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **isActive** | **bool** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body10.md 0000644 00000002025 15021222673 0012015 0 ustar 00 # Body10 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **visitorId** | **string** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> | **text** | **string** | message text | **agentId** | **string** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional] **groupId** | **string** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md 0000644 00000001523 15021222673 0023211 0 ustar 00 # GetExtendedContactDetailsStatisticsUnsubscriptions ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userUnsubscription** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) | Contact unsubscribe via unsubscription link in a campaign | **adminUnsubscription** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]**](GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailBcc.md 0000644 00000000730 15021222673 0014075 0 ustar 00 # SendSmtpEmailBcc ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the recipient in bcc | **name** | **string** | Name of the recipient in bcc. Maximum allowed characters are 70. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ExportWebhooksHistory.md 0000644 00000002333 15021222673 0015326 0 ustar 00 # ExportWebhooksHistory ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **days** | **int** | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ | [optional] **startDate** | **string** | Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate | [optional] **endDate** | **string** | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] **sort** | **string** | Sorting order of records (asc or desc) | [optional] **event** | **string** | Filter the history for a specific event type | **notifyURL** | **string** | Webhook URL to receive CSV file link | **webhookId** | **int** | Filter the history for a specific webhook id | [optional] **email** | **string** | Filter the history for a specific email | [optional] **messageId** | **int** | Filter the history for a specific message id | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSenderModel.md 0000644 00000001231 15021222673 0014302 0 ustar 00 # CreateSenderModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the Sender created | **spfError** | **bool** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] **dkimError** | **bool** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfoApiKeysV2.md 0000644 00000000635 15021222673 0014761 0 ustar 00 # GetChildInfoApiKeysV2 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the key for version 2 | **key** | **string** | API Key for version 2 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/NoteId.md 0000644 00000000530 15021222673 0012140 0 ustar 00 # NoteId ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique note Id | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsOpened.md 0000644 00000001120 15021222673 0021202 0 ustar 00 # GetExtendedContactDetailsStatisticsOpened ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **count** | **int** | Number of openings for the campaign | **eventTime** | **string** | UTC date-time of the event | **ip** | **string** | IP from which the user has opened the email | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedCampaignOverview.md 0000644 00000007441 15021222673 0016355 0 ustar 00 # GetExtendedCampaignOverview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **string** | Name of the campaign | **subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **type** | **string** | Type of campaign | **status** | **string** | Status of the campaign | **scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] **abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] **subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerDelay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] **sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] **testSent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) | **header** | **string** | Header of the campaign | **footer** | **string** | Footer of the campaign | **sender** | [**\Brevo\Client\Model\GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | | **replyTo** | **string** | Email defined as the \"Reply to\" of the campaign | **toField** | **string** | Customisation of the \"to\" field of the campaign | [optional] **htmlContent** | **string** | HTML content of the campaign | **shareLink** | **string** | Link to share the campaign on social medias | [optional] **tag** | **string** | Tag of the campaign | [optional] **createdAt** | **string** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] **mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] **sentDate** | **string** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] **returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ErrorModel.md 0000644 00000000667 15021222673 0013043 0 ustar 00 # ErrorModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **string** | Error code displayed in case of a failure | **message** | **string** | Readable message associated to the failure | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsDelivered.md 0000644 00000000721 15021222673 0021701 0 ustar 00 # GetExtendedContactDetailsStatisticsDelivered ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **eventTime** | **string** | UTC date-time of the event | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/DealAttributes.md 0000644 00000000455 15021222673 0013700 0 ustar 00 # DealAttributes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateDoiContact.md 0000644 00000002227 15021222673 0014136 0 ustar 00 # CreateDoiContact ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | **attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] **includeListIds** | **int[]** | Lists under user account where contact should be added | **excludeListIds** | **int[]** | Lists under user account where contact should not be added | [optional] **templateId** | **int** | Id of the Double opt-in (DOI) template | **redirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetIpFromSender.md 0000644 00000000745 15021222673 0013763 0 ustar 00 # GetIpFromSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the dedicated IP | **ip** | **string** | Dedicated IP | **domain** | **string** | Domain associated to the IP | **weight** | **int** | Weight of the IP | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetEmailEventReport.md 0000644 00000000644 15021222673 0014651 0 ustar 00 # GetEmailEventReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**\Brevo\Client\Model\GetEmailEventReportEvents[]**](GetEmailEventReportEvents.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/DeleteHardbounces.md 0000644 00000001414 15021222673 0014340 0 ustar 00 # DeleteHardbounces ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **startDate** | **string** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional] **endDate** | **string** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional] **contactEmail** | **string** | Target a specific email address | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSegmentsSegments.md 0000644 00000001132 15021222673 0014710 0 ustar 00 # GetSegmentsSegments ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the list | [optional] **segmentName** | **string** | Name of the Segment | [optional] **categoryName** | **string** | Name of the Segment Category | [optional] **updatedAt** | **string** | Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateBatchCategoryModel.md 0000644 00000000742 15021222673 0016752 0 ustar 00 # CreateUpdateBatchCategoryModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **createdCount** | **int** | Number of the new created categories | [optional] **updatedCount** | **int** | Number of the existing categories updated | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAggregatedReport.md 0000644 00000002526 15021222673 0014653 0 ustar 00 # GetAggregatedReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **range** | **string** | Time frame of the report | [optional] **requests** | **int** | Number of requests for the timeframe | [optional] **delivered** | **int** | Number of delivered emails for the timeframe | [optional] **hardBounces** | **int** | Number of hardbounces for the timeframe | [optional] **softBounces** | **int** | Number of softbounces for the timeframe | [optional] **clicks** | **int** | Number of clicks for the timeframe | [optional] **uniqueClicks** | **int** | Number of unique clicks for the timeframe | [optional] **opens** | **int** | Number of openings for the timeframe | [optional] **uniqueOpens** | **int** | Number of unique openings for the timeframe | [optional] **spamReports** | **int** | Number of complaint (spam report) for the timeframe | [optional] **blocked** | **int** | Number of blocked contact emails for the timeframe | [optional] **invalid** | **int** | Number of invalid emails for the timeframe | [optional] **unsubscribed** | **int** | Number of unsubscribed emails for the timeframe | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ConversationsMessageFile.md 0000644 00000001237 15021222673 0015725 0 ustar 00 # ConversationsMessageFile ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **filename** | **string** | Name of the file | [optional] **size** | **int** | Size in bytes | [optional] **isImage** | **bool** | Whether the file is an image | [optional] **url** | **string** | URL of the file | [optional] **imageInfo** | [**\Brevo\Client\Model\ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsCampaigns.md 0000644 00000000642 15021222673 0014007 0 ustar 00 # GetSmsCampaigns ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaigns** | **object[]** | | [optional] **count** | **int** | Number of SMS campaigns retrieved | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateContactModel.md 0000644 00000000610 15021222673 0015620 0 ustar 00 # CreateUpdateContactModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the contact when a new contact is created | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWATemplates.md 0000644 00000000722 15021222673 0013607 0 ustar 00 # GetWATemplates ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **templates** | [**\Brevo\Client\Model\GetWATemplatesTemplates[]**](GetWATemplatesTemplates.md) | | **count** | **int** | Number of whatsApp templates retrived | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateContact.md 0000644 00000003311 15021222673 0013514 0 ustar 00 # UpdateContact ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] **extId** | **string** | Pass your own Id to update ext_id of a contact. | [optional] **emailBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] **smsBlacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] **listIds** | **int[]** | Ids of the lists to add the contact to | [optional] **unlinkListIds** | **int[]** | Ids of the lists to remove the contact from | [optional] **smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfoStatistics.md 0000644 00000001110 15021222673 0015323 0 ustar 00 # GetChildInfoStatistics ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **previousMonthTotalSent** | **int** | Overall emails sent for the previous month | [optional] **currentMonthTotalSent** | **int** | Overall emails sent for current month | [optional] **totalSent** | **int** | Overall emails sent for since the account exists | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInboundEmailEvents.md 0000644 00000000652 15021222673 0015156 0 ustar 00 # GetInboundEmailEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**\Brevo\Client\Model\GetInboundEmailEventsEvents[]**](GetInboundEmailEventsEvents.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactCampaignStats.md 0000644 00000003210 15021222673 0015466 0 ustar 00 # GetContactCampaignStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **messagesSent** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] **hardBounces** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] **softBounces** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] **complaints** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] **unsubscriptions** | [**\Brevo\Client\Model\GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) | | [optional] **opened** | [**\Brevo\Client\Model\GetContactCampaignStatsOpened[]**](GetContactCampaignStatsOpened.md) | | [optional] **clicked** | [**\Brevo\Client\Model\GetContactCampaignStatsClicked[]**](GetContactCampaignStatsClicked.md) | | [optional] **transacAttributes** | [**\Brevo\Client\Model\GetContactCampaignStatsTransacAttributes[]**](GetContactCampaignStatsTransacAttributes.md) | | [optional] **delivered** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]**](GetExtendedContactDetailsStatisticsMessagesSent.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CompanyAttributes.md 0000644 00000000460 15021222673 0014435 0 ustar 00 # CompanyAttributes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWebhooks.md 0000644 00000000514 15021222673 0013201 0 ustar 00 # GetWebhooks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **webhooks** | **object[]** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CompaniesList.md 0000644 00000000611 15021222673 0013530 0 ustar 00 # CompaniesList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **items** | [**\Brevo\Client\Model\Company[]**](Company.md) | List of compaies | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateBatchContacts.md 0000644 00000000710 15021222673 0014641 0 ustar 00 # UpdateBatchContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contacts** | [**\Brevo\Client\Model\UpdateBatchContactsContacts[]**](UpdateBatchContactsContacts.md) | List of contacts to be updated | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedList.md 0000644 00000001274 15021222673 0014020 0 ustar 00 # GetExtendedList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **folderId** | **int** | ID of the folder | **createdAt** | **string** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) | **campaignStats** | [**\Brevo\Client\Model\GetExtendedListCampaignStats[]**](GetExtendedListCampaignStats.md) | | [optional] **dynamicList** | **bool** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/BlockDomain.md 0000644 00000000550 15021222673 0013142 0 ustar 00 # BlockDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domain** | **string** | name of the domain to be blocked | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateApiKeyRequest.md 0000644 00000000645 15021222673 0014644 0 ustar 00 # CreateApiKeyRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Id of the sub-account organization | **name** | **string** | Name of the API key | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountPlan.md 0000644 00000002143 15021222673 0013627 0 ustar 00 # GetAccountPlan ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | Displays the plan type of the user | **creditsType** | **string** | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | **credits** | **float** | Remaining credits of the user | **startDate** | [**\DateTime**] | Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) | [optional] **endDate** | [**\DateTime**] | Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) | [optional] **userLimit** | **int** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetEmailEventReportEvents.md 0000644 00000002440 15021222673 0016032 0 ustar 00 # GetEmailEventReportEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address which generates the event | **date** | **string** | UTC date-time on which the event has been generated | **subject** | **string** | Subject of the event | [optional] **messageId** | **string** | Message ID which generated the event | **event** | **string** | Event which occurred | **reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] **tag** | **string** | Tag of the email which generated the event | [optional] **ip** | **string** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional] **link** | **string** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional] **from** | **string** | Sender email from which the emails are sent | [optional] **templateId** | **int** | ID of the template (only available if the email is template based) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateApiKeyResponse.md 0000644 00000000645 15021222673 0015012 0 ustar 00 # CreateApiKeyResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **string** | Status of the API operation. | [optional] **key** | **string** | API Key | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacBlockedContacts.md 0000644 00000001011 15021222673 0015767 0 ustar 00 # GetTransacBlockedContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Count of blocked or unsubscribed contact | [optional] **contacts** | [**\Brevo\Client\Model\GetTransacBlockedContactsContacts[]**](GetTransacBlockedContactsContacts.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestContactImportNewList.md 0000644 00000001122 15021222673 0016421 0 ustar 00 # RequestContactImportNewList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **listName** | **string** | List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). | [optional] **folderId** | **int** | Id of the folder where this new list shall be created (Mandatory if listName is not empty). | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountRelay.md 0000644 00000000765 15021222673 0014021 0 ustar 00 # GetAccountRelay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enabled** | **bool** | Status of your transactional email Account (true=Enabled, false=Disabled) | **data** | [**\Brevo\Client\Model\GetAccountRelayData**](GetAccountRelayData.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/PostSendFailed.md 0000644 00000001043 15021222673 0013622 0 ustar 00 # PostSendFailed ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **int** | Response code | **message** | **string** | Response message | **unexistingEmails** | **string[]** | | [optional] **withoutListEmails** | **string[]** | | [optional] **blackListedEmails** | **string[]** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCampaignOverview.md 0000644 00000003717 15021222673 0014676 0 ustar 00 # GetCampaignOverview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **string** | Name of the campaign | **subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **previewText** | **string** | Preview text or preheader of the email campaign | [optional] **type** | **string** | Type of campaign | **status** | **string** | Status of the campaign | **scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] **abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] **subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerDelay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] **sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestCampaignResult.md 0000644 00000002415 15021222673 0015003 0 ustar 00 # AbTestCampaignResult ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **winningVersion** | **string** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional] **winningCriteria** | **string** | Criteria choosen for winning version (Open/Click) | [optional] **winningSubjectLine** | **string** | Subject Line of current winning version | [optional] **openRate** | **string** | Open rate for current winning version | [optional] **clickRate** | **string** | Click rate for current winning version | [optional] **winningVersionRate** | **string** | Open/Click rate for the winner version | [optional] **statistics** | [**\Brevo\Client\Model\AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional] **clickedLinks** | [**\Brevo\Client\Model\AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body1.md 0000644 00000002131 15021222673 0011733 0 ustar 00 # Body1 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of task | **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | **date** | [**\DateTime**] | Task date/time | **notes** | **string** | Notes added to a task | [optional] **done** | **bool** | Task marked as done | [optional] **assignToId** | **string** | User id to whom task is assigned | [optional] **contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] **dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] **companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] **reminder** | [**\Brevo\Client\Model\TaskReminder**](TaskReminder.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsCampaignRecipients.md 0000644 00000000467 15021222673 0015657 0 ustar 00 # GetSmsCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSmtpTemplateSender.md 0000644 00000001240 15021222673 0015661 0 ustar 00 # CreateSmtpTemplateSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the sender. If not passed, will be set to default | [optional] **email** | **string** | Email of the sender | [optional] **id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsappCampaigns.md 0000644 00000000772 15021222673 0015040 0 ustar 00 # GetWhatsappCampaigns ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaigns** | [**\Brevo\Client\Model\GetWhatsappCampaignsCampaigns[]**](GetWhatsappCampaignsCampaigns.md) | | [optional] **count** | **int** | Number of WhatsApp campaigns retrived | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInboundEmailEventsByUuidAttachments.md 0000644 00000001273 15021222673 0020474 0 ustar 00 # GetInboundEmailEventsByUuidAttachments ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | filename specified in the Content-Disposition header of the attachment | [optional] **contentType** | **string** | value of the Content-Type header of the attachment | [optional] **contentId** | **string** | value of the Content-ID header of the attachment. | [optional] **contentLength** | **int** | size of the attachment in bytes | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body5.md 0000644 00000001224 15021222673 0011741 0 ustar 00 # Body5 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **linkContactIds** | **int[]** | Contact ids for contacts to be linked with deal | [optional] **unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from deal | [optional] **linkCompanyIds** | **string[]** | Company ids to be linked with deal | [optional] **unlinkCompanyIds** | **string[]** | Company ids to be unlinked from deal | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailTo.md 0000644 00000000711 15021222673 0013767 0 ustar 00 # SendSmtpEmailTo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the recipient | **name** | **string** | Name of the recipient. Maximum allowed characters are 70. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExternalFeedByUUIDHeaders.md 0000644 00000000657 15021222673 0016254 0 ustar 00 # GetExternalFeedByUUIDHeaders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the header | [optional] **value** | **string** | Value of the header | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AddChildDomain.md 0000644 00000000607 15021222673 0013547 0 ustar 00 # AddChildDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domain** | **string** | Sender domain to add for a specific child account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetFolder.md 0000644 00000001140 15021222673 0012627 0 ustar 00 # GetFolder ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the folder | **name** | **string** | Name of the folder | **totalBlacklisted** | **int** | Number of blacklisted contacts in the folder | **totalSubscribers** | **int** | Number of contacts in the folder | **uniqueSubscribers** | **int** | Number of unique contacts in the folder | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsCampaign.md 0000644 00000001737 15021222673 0013632 0 ustar 00 # GetSmsCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the SMS Campaign | **name** | **string** | Name of the SMS Campaign | **status** | **string** | Status of the SMS Campaign | **content** | **string** | Content of the SMS Campaign | **scheduledAt** | **string** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] **sender** | **string** | Sender of the SMS Campaign | **createdAt** | **string** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **recipients** | **object** | | **statistics** | **object** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RemoveCredits.md 0000644 00000001036 15021222673 0013533 0 ustar 00 # RemoveCredits ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sms** | **int** | Required if email credits are empty. SMS credits to be removed from the child account | [optional] **email** | **int** | Required if sms credits are empty. Email credits to be removed from the child account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateBatchCategory.md 0000644 00000001102 15021222673 0015760 0 ustar 00 # CreateUpdateBatchCategory ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **categories** | [**\Brevo\Client\Model\CreateUpdateCategories[]**](CreateUpdateCategories.md) | array of categories objects | **updateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSenderIps.md 0000644 00000001174 15021222673 0014003 0 ustar 00 # CreateSenderIps ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ip** | **string** | Dedicated IP available in your account | **domain** | **string** | Domain of the IP | **weight** | **int** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildDomain.md 0000644 00000000667 15021222673 0013604 0 ustar 00 # GetChildDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domain** | **string** | Sender domain | [optional] **active** | **bool** | indicates whether a domain is verified or not | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetProducts.md 0000644 00000000570 15021222673 0013225 0 ustar 00 # GetProducts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **products** | **object[]** | | **count** | **int** | Number of products | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Conversationsmessage.md 0000644 00000002577 15021222673 0015175 0 ustar 00 # ConversationsMessage ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Message ID. It can be used for further manipulations with the message. | [optional] **type** | **string** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] **text** | **string** | Message text or name of the attached file | [optional] **visitorId** | **string** | visitor’s ID | [optional] **agentId** | **string** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] **agentName** | **string** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] **createdAt** | **int** | Timestamp in milliseconds. | [optional] **isPushed** | **bool** | `true` for pushed messages | [optional] **receivedFrom** | **string** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] **file** | [**\Brevo\Client\Model\ConversationsMessageFile**](ConversationsMessageFile.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsLinks.md 0000644 00000001104 15021222673 0021052 0 ustar 00 # GetExtendedContactDetailsStatisticsLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Number of clicks on this link for the campaign | **eventTime** | **string** | UTC date-time of the event | **ip** | **string** | IP from which the user has clicked on the link | **url** | **string** | URL of the clicked link | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateproduct.md 0000644 00000002642 15021222673 0014733 0 ustar 00 # CreateUpdateProduct ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Product ID for which you requested the details | **name** | **string** | Mandatory in case of creation**. Name of the product for which you requested the details | **url** | **string** | URL to the product | [optional] **imageUrl** | **string** | Absolute URL to the cover image of the product | [optional] **sku** | **string** | Product identifier from the shop | [optional] **price** | **float** | Price of the product | [optional] **categories** | **string[]** | Category ID-s of the product | [optional] **parentId** | **string** | Parent product id of the product | [optional] **metaInfo** | **map[string,string]** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] **updateEnabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to false] **deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse2013.md 0000644 00000000553 15021222673 0014226 0 ustar 00 # InlineResponse2013 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **messageId** | **string** | messageId of sent message | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoCredits.md 0000644 00000001054 15021222673 0021020 0 ustar 00 # SubAccountDetailsResponsePlanInfoCredits ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sms** | **int** | SMS credits remaining on the sub-account | [optional] **emails** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetBlockedDomains.md 0000644 00000000554 15021222673 0014302 0 ustar 00 # GetBlockedDomains ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domains** | **string[]** | List of all blocked domains | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponse.md 0000644 00000001727 15021222673 0015247 0 ustar 00 # MasterDetailsResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email id of master account | [optional] **companyName** | **string** | Company name of master account organization | [optional] **id** | **int** | Unique identifier of the master account organization | [optional] **currencyCode** | **string** | Currency code of the master account organization | [optional] **timezone** | **string** | Timezone of the master account organization | [optional] **billingInfo** | [**\Brevo\Client\Model\MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) | | [optional] **planInfo** | [**\Brevo\Client\Model\MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreatedBatchId.md 0000644 00000000542 15021222673 0013547 0 ustar 00 # CreatedBatchId ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **batchId** | **float** | Batch ID of the request | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSmsCampaignRecipients.md 0000644 00000001003 15021222673 0016326 0 ustar 00 # CreateSmsCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | **exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateChildDomain.md 0000644 00000000632 15021222673 0014277 0 ustar 00 # UpdateChildDomain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domain** | **string** | Value for the sender domain that will replace the existing domain | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse201.md 0000644 00000000530 15021222673 0014136 0 ustar 00 # InlineResponse201 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique deal id | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacEmailContent.md 0000644 00000001633 15021222673 0015321 0 ustar 00 # GetTransacEmailContent ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address to which transactional email has been sent | **subject** | **string** | Subject of the sent email | **templateId** | **int** | Id of the template | [optional] **date** | **string** | Date on which transactional email was sent | **events** | [**\Brevo\Client\Model\GetTransacEmailContentEvents[]**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email | **body** | **string** | Actual content of the transactional email that has been sent | **attachmentCount** | **int** | Count of the attachments that were sent in the email | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponseBillingInfo.md 0000644 00000001346 15021222673 0017361 0 ustar 00 # MasterDetailsResponseBillingInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Billing email id of master account | [optional] **companyName** | **string** | Company name of master account | [optional] **name** | [**\Brevo\Client\Model\MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) | | [optional] **address** | [**\Brevo\Client\Model\MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Note.md 0000644 00000001374 15021222673 0011672 0 ustar 00 # Note ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique note Id | [optional] **text** | **string** | Text content of a note | **contactIds** | **int[]** | Contact ids linked to a note | [optional] **dealIds** | **string[]** | Deal ids linked to a note | [optional] **authorId** | **object** | Account details of user which created the note | [optional] **createdAt** | [**\DateTime**] | Note created date/time | [optional] **updatedAt** | [**\DateTime**] | Note updated date/time | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSms.md 0000644 00000001137 15021222673 0012336 0 ustar 00 # SendSms ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reference** | **string** | | **messageId** | **int** | | **smsCount** | **int** | Count of SMS's to send multiple text messages | [optional] **usedCredits** | **float** | SMS credits used per text message | [optional] **remainingCredits** | **float** | Remaining SMS credits of the user | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfoCredits.md 0000644 00000000722 15021222673 0014576 0 ustar 00 # GetChildInfoCredits ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emailCredits** | **int** | Email credits available for your child | [optional] **smsCredits** | **int** | SMS credits available for your child | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body9.md 0000644 00000000523 15021222673 0011746 0 ustar 00 # Body9 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **text** | **string** | edited message text | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AddCredits.md 0000644 00000001023 15021222673 0012762 0 ustar 00 # AddCredits ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional] **email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedClientAddress.md 0000644 00000000770 15021222673 0015631 0 ustar 00 # GetExtendedClientAddress ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **street** | **string** | Street information | **city** | **string** | City information | **zipCode** | **string** | Zip Code information | **country** | **string** | Country information | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/FileList.md 0000644 00000000447 15021222673 0012500 0 ustar 00 # FileList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateExternalFeed.md 0000644 00000002122 15021222673 0014447 0 ustar 00 # CreateExternalFeed ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the feed | **url** | **string** | URL of the feed | **authType** | **string** | Auth type of the feed: * `basic` * `token` * `noAuth` | [optional] [default to 'noAuth'] **username** | **string** | Username for authType `basic` | [optional] **password** | **string** | Password for authType `basic` | [optional] **token** | **string** | Token for authType `token` | [optional] **headers** | [**\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] **maxRetries** | **int** | Maximum number of retries on the feed url | [optional] **cache** | **bool** | Toggle caching of feed url response | [optional] [default to false] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/WhatsappCampStats.md 0000644 00000000674 15021222673 0014376 0 ustar 00 # WhatsappCampStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sent** | **int** | | **delivered** | **int** | | **read** | **int** | | **unsubscribe** | **int** | | **notSent** | **int** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RequestContactImport.md 0000644 00000004764 15021222673 0015132 0 ustar 00 # RequestContactImport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fileUrl** | **string** | Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json | [optional] **fileBody** | **string** | Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. | [optional] **jsonBody** | [**\Brevo\Client\Model\RequestContactImportJsonBody[]**](RequestContactImportJsonBody.md) | **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. | [optional] **listIds** | **int[]** | Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. | [optional] **notifyUrl** | **string** | URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] **newList** | [**\Brevo\Client\Model\RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional] **emailBlacklist** | **bool** | To blacklist all the contacts for email | [optional] [default to false] **smsBlacklist** | **bool** | To blacklist all the contacts for sms | [optional] [default to false] **updateExistingContacts** | **bool** | To facilitate the choice to update the existing contacts | [optional] [default to true] **emptyContactsAttributes** | **bool** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) | [optional] [default to false] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body2.md 0000644 00000001254 15021222673 0011741 0 ustar 00 # Body2 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **linkContactIds** | **int[]** | Contact ids for contacts to be linked with company | [optional] **unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from company | [optional] **linkDealsIds** | **string[]** | Deals ids for deals to be linked with company | [optional] **unlinkDealsIds** | **string[]** | Deals ids for deals to be unlinked from company | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ManageIp.md 0000644 00000000530 15021222673 0012437 0 ustar 00 # ManageIp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ip** | **string** | Dedicated ID | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/DealsList.md 0000644 00000000574 15021222673 0012652 0 ustar 00 # DealsList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **items** | [**\Brevo\Client\Model\Deal[]**](Deal.md) | List of deals | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateContact.md 0000644 00000003156 15021222673 0013504 0 ustar 00 # CreateContact ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {'SMS':'+91xxxxxxxxxx'} or {'SMS':'0091xxxxxxxxxx'} | [optional] **extId** | **string** | Pass your own Id to create a contact. | [optional] **attributes** | **object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` | [optional] **emailBlacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] **smsBlacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] **listIds** | **int[]** | Ids of the lists to add the contact to | [optional] **updateEnabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false] **smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/OrderProducts.md 0000644 00000001110 15021222673 0013550 0 ustar 00 # OrderProducts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **productId** | **string** | ID of the product. | **quantity** | **float** | How many pieces of the product the visitor has added to the cart. | **variantId** | **string** | Product ID of the red color shirts. | [optional] **price** | **float** | The price of a unit of product | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInvitedUsersListFeatureAccess.md 0000644 00000001037 15021222673 0017337 0 ustar 00 # GetInvitedUsersListFeatureAccess ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **marketing** | **object** | Marketing features accessiblity. | [optional] **conversations** | **object** | Conversations features accessiblity. | [optional] **crm** | **object** | CRM features accessiblity. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInvitedUsersList.md 0000644 00000000667 15021222673 0014711 0 ustar 00 # GetInvitedUsersList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **users** | [**\Brevo\Client\Model\GetInvitedUsersListUsers[]**](GetInvitedUsersListUsers.md) | Get invited users list | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetails.md 0000644 00000002262 15021222673 0016004 0 ustar 00 # GetExtendedContactDetails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the contact for which you requested the details | **id** | **int** | ID of the contact for which you requested the details | **emailBlacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | **smsBlacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | **createdAt** | **string** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **listIds** | **int[]** | | **listUnsubscribed** | **int[]** | | [optional] **attributes** | **object** | Set of attributes of the contact | **statistics** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatistics**](GetExtendedContactDetailsStatistics.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ComponentItems.md 0000644 00000000573 15021222673 0013731 0 ustar 00 # ComponentItems ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **string** | | [optional] **text** | **string** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSubAccountResponse.md 0000644 00000000553 15021222673 0015674 0 ustar 00 # CreateSubAccountResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the sub-account created | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateSender.md 0000644 00000001163 15021222673 0013325 0 ustar 00 # CreateSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | From Name to use for the sender | **email** | **string** | From email to use for the sender. A verification email will be sent to this address. | **ips** | [**\Brevo\Client\Model\CreateSenderIps[]**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/NoteList.md 0000644 00000000447 15021222673 0012526 0 ustar 00 # NoteList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateEmailCampaignSender.md 0000644 00000001141 15021222673 0015731 0 ustar 00 # CreateEmailCampaignSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Sender Name | [optional] **email** | **string** | Sender email | **id** | **int** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/RemainingCreditModelChild.md 0000644 00000000700 15021222673 0015746 0 ustar 00 # RemainingCreditModelChild ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sms** | **double** | SMS Credits remaining for child account | **email** | **double** | Email Credits remaining for child account | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/BodyVariablesItems.md 0000644 00000000461 15021222673 0014511 0 ustar 00 # BodyVariablesItems ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountUpdatePlanRequest.md 0000644 00000001103 15021222673 0016350 0 ustar 00 # SubAccountUpdatePlanRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **credits** | [**\Brevo\Client\Model\SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) | | [optional] **features** | [**\Brevo\Client\Model\SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/DealAttributesInner.md 0000644 00000001035 15021222673 0014667 0 ustar 00 # DealAttributesInner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **internalName** | **string** | | [optional] **label** | **string** | | [optional] **attributeTypeName** | **string** | | [optional] **attributeOptions** | **object[]** | | [optional] **isRequired** | **bool** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponseBillingInfoAddress.md 0000644 00000001137 15021222673 0020665 0 ustar 00 # MasterDetailsResponseBillingInfoAddress ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **streetAddress** | **string** | Street address | [optional] **locality** | **string** | Locality | [optional] **postalCode** | **string** | Postal code | [optional] **stateCode** | **string** | State code | [optional] **countryCode** | **string** | Country code | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateEmailCampaign.md 0000644 00000015305 15021222673 0014616 0 ustar 00 # UpdateEmailCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tag** | **string** | Tag of the campaign | [optional] **sender** | [**\Brevo\Client\Model\UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) | | [optional] **name** | **string** | Name of the campaign | [optional] **htmlContent** | **string** | Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty | [optional] **htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] **scheduledAt** | **string** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] **subject** | **string** | Subject of the campaign | [optional] **previewText** | **string** | Preview text or preheader of the email campaign | [optional] **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] **recipients** | [**\Brevo\Client\Model\UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional] **attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false] **mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false] **footer** | **string** | Footer of the email campaign | [optional] **header** | **string** | Header of the email campaign | [optional] **utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] **params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] **abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false] **subjectA** | **string** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] **subjectB** | **string** | Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] **splitRule** | **int** | Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] **winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record | [optional] **winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record | [optional] **ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false] **initialQuota** | **int** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] **increaseRate** | **int** | Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional] **unsubscriptionPageId** | **string** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. | [optional] **updateFormId** | **string** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/OrderBilling.md 0000644 00000001652 15021222673 0013340 0 ustar 00 # OrderBilling ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | **string** | Full billing address. | [optional] **city** | **string** | Exact city of the address. | [optional] **countryCode** | **string** | Billing country 2-letter ISO code. | [optional] **phone** | **string** | Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. | [optional] **postCode** | **string** | Postcode for delivery and billing. | [optional] **paymentMethod** | **string** | How the visitor will pay for the item(s), e.g. paypal, check, etc. | [optional] **region** | **string** | Exact region (state/province) for delivery and billing. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/PostContactInfoContacts.md 0000644 00000001230 15021222673 0015530 0 ustar 00 # PostContactInfoContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **string[]** | | [optional] **failure** | **string[]** | | [optional] **total** | **int** | Displays the count of total number of contacts removed from list when user opts for \"all\" option. | [optional] **processId** | **int** | Id of the process created to remove contacts from list when user opts for \"all\" option. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponse.md 0000644 00000001223 15021222673 0016051 0 ustar 00 # SubAccountDetailsResponse ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the sub-account user | [optional] **email** | **string** | Email id of the sub-account organization | [optional] **companyName** | **string** | Sub-account company name | [optional] **planInfo** | [**\Brevo\Client\Model\SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateCampaignStatus.md 0000644 00000000657 15021222673 0015056 0 ustar 00 # UpdateCampaignStatus ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **string** | Note:- replicateTemplate status will be available only for template type campaigns. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmtpTemplateOverview.md 0000644 00000002706 15021222673 0015573 0 ustar 00 # GetSmtpTemplateOverview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the template | **name** | **string** | Name of the template | **subject** | **string** | Subject of the template | **isActive** | **bool** | Status of template (true=active, false=inactive) | **testSent** | **bool** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | **sender** | [**\Brevo\Client\Model\GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) | | **replyTo** | **string** | Email defined as the \"Reply to\" for the template | **toField** | **string** | Customisation of the \"to\" field for the template | **tag** | **string** | Tag of the template | **htmlContent** | **string** | HTML content of the template | **createdAt** | **string** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | **doiTemplate** | **bool** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSendersListIps.md 0000644 00000000731 15021222673 0014334 0 ustar 00 # GetSendersListIps ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ip** | **string** | Dedicated IP available in your account | **domain** | **string** | Domain of the IP | **weight** | **int** | Weight of the IP for this sender | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Otp.md 0000644 00000000543 15021222673 0011524 0 ustar 00 # Otp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **int** | 6 digit OTP received on email | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateProducts.md 0000644 00000002411 15021222673 0015050 0 ustar 00 # CreateUpdateProducts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Product ID for which you requested the details | **name** | **string** | Mandatory in case of creation**. Name of the product for which you requested the details | **url** | **string** | URL to the product | [optional] **imageUrl** | **string** | Absolute URL to the cover image of the product | [optional] **sku** | **string** | Product identifier from the shop | [optional] **price** | **float** | Price of the product | [optional] **categories** | **string[]** | Category ID-s of the product | [optional] **parentId** | **string** | Parent product id of the product | [optional] **metaInfo** | **map[string,string]** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] **deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AuthenticateDomainModel.md 0000644 00000000614 15021222673 0015510 0 ustar 00 # AuthenticateDomainModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **domainName** | **string** | Domain | **message** | **string** | Success message | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestVersionClicksInner.md 0000644 00000000775 15021222673 0015646 0 ustar 00 # AbTestVersionClicksInner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **link** | **string** | URL of the link | **clicksCount** | **int** | Number of times a link is clicked | **clickRate** | **string** | Percentage of clicks of link with respect to total clicks | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSendersList.md 0000644 00000000705 15021222673 0013661 0 ustar 00 # GetSendersList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **senders** | [**\Brevo\Client\Model\GetSendersListSenders[]**](GetSendersListSenders.md) | List of the senders available in your account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateEmailCampaignRecipients.md 0000644 00000001166 15021222673 0016625 0 ustar 00 # CreateEmailCampaignRecipients ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **exclusionListIds** | **int[]** | List ids to exclude from the campaign | [optional] **listIds** | **int[]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] **segmentIds** | **int[]** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmsEventReportEvents.md 0000644 00000001535 15021222673 0015551 0 ustar 00 # GetSmsEventReportEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **phoneNumber** | **string** | Phone number which has generated the event | [optional] **date** | **string** | UTC date-time on which the event has been generated | [optional] **messageId** | **string** | Message ID which generated the event | [optional] **event** | **string** | Event which occurred | [optional] **reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] **reply** | **string** | | [optional] **tag** | **string** | Tag of the SMS which generated the event | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactCampaignStatsTransacAttributes.md 0000644 00000000734 15021222673 0021061 0 ustar 00 # GetContactCampaignStatsTransacAttributes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderDate** | [**\DateTime**] | Date of the order | **orderPrice** | **float** | Price of the order | **orderId** | **int** | ID of the order | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsappEventReport.md 0000644 00000000655 15021222673 0015413 0 ustar 00 # GetWhatsappEventReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**\Brevo\Client\Model\GetWhatsappEventReportEvents[]**](GetWhatsappEventReportEvents.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacEmailsList.md 0000644 00000001120 15021222673 0014774 0 ustar 00 # GetTransacEmailsList ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **count** | **int** | Total number of transactional emails available on your account according to the passed filter | [optional] **transactionalEmails** | [**\Brevo\Client\Model\GetTransacEmailsListTransactionalEmails[]**](GetTransacEmailsListTransactionalEmails.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailTo1.md 0000644 00000000716 15021222673 0014055 0 ustar 00 # SendSmtpEmailTo1 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the recipient | **name** | **string** | Name of the recipient. **Maximum allowed characters are 70**. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacSmsReport.md 0000644 00000000647 15021222673 0014701 0 ustar 00 # GetTransacSmsReport ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reports** | [**\Brevo\Client\Model\GetTransacSmsReportReports[]**](GetTransacSmsReportReports.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountRelayData.md 0000644 00000000744 15021222673 0014610 0 ustar 00 # GetAccountRelayData ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userName** | **string** | Email to use as login on transactional platform | **relay** | **string** | URL of the SMTP Relay | **port** | **int** | Port used for SMTP Relay | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetContactDetails.md 0000644 00000002057 15021222673 0014325 0 ustar 00 # GetContactDetails ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the contact for which you requested the details | **id** | **int** | ID of the contact for which you requested the details | **emailBlacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | **smsBlacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | **createdAt** | **string** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **listIds** | **int[]** | | **listUnsubscribed** | **int[]** | | [optional] **attributes** | **object** | Set of attributes of the contact | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedClient.md 0000644 00000000624 15021222673 0014321 0 ustar 00 # GetExtendedClient ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **address** | [**\Brevo\Client\Model\GetExtendedClientAddress**](GetExtendedClientAddress.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/TaskTypes.md 0000644 00000000626 15021222673 0012713 0 ustar 00 # TaskTypes ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Id of task type | [optional] **title** | **string** | Title of task type | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateExternalFeed.md 0000644 00000002123 15021222673 0014467 0 ustar 00 # UpdateExternalFeed ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the feed | [optional] **url** | **string** | URL of the feed | [optional] **authType** | **string** | Auth type of the feed: * `basic` * `token` * `noAuth` | [optional] **username** | **string** | Username for authType `basic` | [optional] **password** | **string** | Password for authType `basic` | [optional] **token** | **string** | Token for authType `token` | [optional] **headers** | [**\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] **maxRetries** | **int** | Maximum number of retries on the feed url | [optional] **cache** | **bool** | Toggle caching of feed url response | [optional] [default to false] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetChildInfoApiKeys.md 0000644 00000000763 15021222673 0014553 0 ustar 00 # GetChildInfoApiKeys ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **v2** | [**\Brevo\Client\Model\GetChildInfoApiKeysV2[]**](GetChildInfoApiKeysV2.md) | | **v3** | [**\Brevo\Client\Model\GetChildInfoApiKeysV3[]**](GetChildInfoApiKeysV3.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendTransacSms.md 0000644 00000003126 15021222673 0013652 0 ustar 00 # SendTransacSms ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | **recipient** | **string** | Mobile number to send SMS with the country code | **content** | **string** | Content of the message. If more than 160 characters long, will be sent as multiple text messages | **type** | **string** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional'] **tag** | **string** | Tag of the message | [optional] **webUrl** | **string** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] **unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false] **organisationPrefix** | **string** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedCampaignStats.md 0000644 00000002140 15021222673 0015634 0 ustar 00 # GetExtendedCampaignStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **globalStats** | [**\Brevo\Client\Model\GetExtendedCampaignStatsGlobalStats**](GetExtendedCampaignStatsGlobalStats.md) | | **campaignStats** | **object[]** | List-wise statistics of the campaign. | **mirrorClick** | **int** | Number of clicks on mirror link | **remaining** | **int** | Number of remaning emails to send | **linksStats** | **object** | Statistics about the number of clicks for the links | **statsByDomain** | [**\Brevo\Client\Model\GetStatsByDomain**](GetStatsByDomain.md) | | **statsByDevice** | [**\Brevo\Client\Model\GetStatsByDevice**](GetStatsByDevice.md) | Statistics about the campaign on the basis of various devices | **statsByBrowser** | [**\Brevo\Client\Model\GetStatsByBrowser**](GetStatsByBrowser.md) | Statistics about the campaign on the basis of various browsers | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetInvitedUsersListUsers.md 0000644 00000001166 15021222673 0015726 0 ustar 00 # GetInvitedUsersListUsers ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the user. | **isOwner** | **string** | Flag for indicating is user owner of the organization. | **status** | **string** | Status of the invited user. | **featureAccess** | [**\Brevo\Client\Model\GetInvitedUsersListFeatureAccess**](GetInvitedUsersListFeatureAccess.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateAttributeEnumeration.md 0000644 00000000621 15021222673 0016255 0 ustar 00 # CreateAttributeEnumeration ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **int** | Id of the value | **label** | **string** | Label of the value | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/AbTestCampaignResultClickedLinks.md 0000644 00000000765 15021222673 0017271 0 ustar 00 # AbTestCampaignResultClickedLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **versionA** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | | **versionB** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetFolderLists.md 0000644 00000000631 15021222673 0013652 0 ustar 00 # GetFolderLists ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **lists** | **object[]** | | [optional] **count** | **int** | Number of lists in the folder | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateReseller.md 0000644 00000000653 15021222673 0013665 0 ustar 00 # CreateReseller ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **authKey** | **string** | AuthKey of Reseller child created | **id** | **int** | Id of Reseller child created | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateUpdateCategory.md 0000644 00000001510 15021222673 0015021 0 ustar 00 # CreateUpdateCategory ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique Category ID as saved in the shop | **name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] **url** | **string** | URL to the category | [optional] **updateEnabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to false] **deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailReplyTo.md 0000644 00000000704 15021222673 0015005 0 ustar 00 # SendSmtpEmailReplyTo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address in reply to | **name** | **string** | Name in reply to. Maximum allowed characters are 70. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponsePlanInfoFeatures.md 0000644 00000001216 15021222673 0020366 0 ustar 00 # MasterDetailsResponsePlanInfoFeatures ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the feature | [optional] **unitValue** | **string** | Unit value of the feature | [optional] **quantity** | **int** | Quantity provided in the plan | [optional] **used** | **int** | Quantity consumed by master | [optional] **remaining** | **int** | Quantity remaining in the plan | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSmtpTemplateOverviewSender.md 0000644 00000000777 15021222673 0016742 0 ustar 00 # GetSmtpTemplateOverviewSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | From email for the template | [optional] **email** | **string** | From email for the template | [optional] **id** | **string** | Sender id of the template | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendTestSms.md 0000644 00000000752 15021222673 0013200 0 ustar 00 # SendTestSms ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **phoneNumber** | **string** | Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacBlockedContactsContacts.md 0000644 00000001265 15021222673 0017501 0 ustar 00 # GetTransacBlockedContactsContacts ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the blocked or unsubscribed contact | **senderEmail** | **string** | Sender email address of the blocked or unsubscribed contact | **reason** | [**\Brevo\Client\Model\GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | | **blockedAt** | **string** | Date when the contact was blocked or unsubscribed on | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Deal.md 0000644 00000001143 15021222673 0011624 0 ustar 00 # Deal ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique deal id | [optional] **attributes** | **object** | Deal attributes with values | [optional] **linkedContactsIds** | **int[]** | Contact ids for contacts linked to this deal | [optional] **linkedCompaniesIds** | **string[]** | Companies ids for companies linked to this deal | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAccountMarketingAutomation.md 0000644 00000001013 15021222673 0016712 0 ustar 00 # GetAccountMarketingAutomation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key** | **string** | Marketing Automation Tracker ID | [optional] **enabled** | **bool** | Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponseBillingInfoName.md 0000644 00000000707 15021222673 0020162 0 ustar 00 # MasterDetailsResponseBillingInfoName ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **givenName** | **string** | First name for billing | [optional] **familyName** | **string** | Last name for billing | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetEmailCampaign.md 0000644 00000007535 15021222673 0014121 0 ustar 00 # GetEmailCampaign ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **string** | Name of the campaign | **subject** | **string** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **type** | **string** | Type of campaign | **status** | **string** | Status of the campaign | **scheduledAt** | **string** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] **abTesting** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] **subjectA** | **string** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **subjectB** | **string** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] **splitRule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerCriteria** | **string** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] **winnerDelay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] **sendAtBestTime** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] **testSent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) | **header** | **string** | Header of the campaign | **footer** | **string** | Footer of the campaign | **sender** | [**\Brevo\Client\Model\GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | | **replyTo** | **string** | Email defined as the \"Reply to\" of the campaign | **toField** | **string** | Customisation of the \"to\" field of the campaign | [optional] **htmlContent** | **string** | HTML content of the campaign | **shareLink** | **string** | Link to share the campaign on social medias | [optional] **tag** | **string** | Tag of the campaign | [optional] **createdAt** | **string** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modifiedAt** | **string** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | **inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] **mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] **sentDate** | **string** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] **returnBounce** | **int** | Total number of non-delivered campaigns for a particular campaign id. | [optional] **recipients** | **object** | | **statistics** | **object** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/MasterDetailsResponsePlanInfo.md 0000644 00000001444 15021222673 0016672 0 ustar 00 # MasterDetailsResponsePlanInfo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currencyCode** | **string** | Plan currency | [optional] **nextBillingAt** | **int** | Timestamp of next billing date | [optional] **price** | **float** | Plan amount | [optional] **planPeriod** | **string** | Plan period type | [optional] **subAccounts** | **int** | Number of sub-accounts | [optional] **features** | [**\Brevo\Client\Model\MasterDetailsResponsePlanInfoFeatures[]**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountAppsToggleRequest.md 0000644 00000003334 15021222673 0016370 0 ustar 00 # SubAccountAppsToggleRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **inbox** | **bool** | Set this field to enable or disable Inbox on the sub-account | [optional] **whatsapp** | **bool** | Set this field to enable or disable Whatsapp campaigns on the sub-account | [optional] **automation** | **bool** | Set this field to enable or disable Automation on the sub-account | [optional] **emailCampaigns** | **bool** | Set this field to enable or disable Email Campaigns on the sub-account | [optional] **smsCampaigns** | **bool** | Set this field to enable or disable SMS Marketing on the sub-account | [optional] **landingPages** | **bool** | Set this field to enable or disable Landing pages on the sub-account | [optional] **transactionalEmails** | **bool** | Set this field to enable or disable Transactional Email on the sub-account | [optional] **transactionalSms** | **bool** | Set this field to enable or disable Transactional SMS on the sub-account | [optional] **facebookAds** | **bool** | Set this field to enable or disable Facebook ads on the sub-account | [optional] **webPush** | **bool** | Set this field to enable or disable Web Push on the sub-account | [optional] **meetings** | **bool** | Set this field to enable or disable Meetings on the sub-account | [optional] **conversations** | **bool** | Set this field to enable or disable Conversations on the sub-account | [optional] **crm** | **bool** | Set this field to enable or disable Sales CRM on the sub-account | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/Body6.md 0000644 00000002141 15021222673 0011741 0 ustar 00 # Body6 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of task | **duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] **taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | **date** | [**\DateTime**] | Task due date and time | **notes** | **string** | Notes added to a task | [optional] **done** | **bool** | Task marked as done | [optional] **assignToId** | **string** | User id to whom task is assigned | [optional] **contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] **dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] **companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] **reminder** | [**\Brevo\Client\Model\TaskReminder**](TaskReminder.md) | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/CreateProductModel.md 0000644 00000000602 15021222673 0014503 0 ustar 00 # CreateProductModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the Product when a new product is created | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetProcess.md 0000644 00000001036 15021222673 0013036 0 ustar 00 # GetProcess ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Id of the process | **status** | **string** | Status of the process | **name** | **string** | Process name | **exportUrl** | **string** | URL on which send export the of contacts once the process is completed | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md 0000644 00000000746 15021222673 0022232 0 ustar 00 # SubAccountDetailsResponsePlanInfoFeaturesUsers ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **int** | Quantity of multi-account's provided | [optional] **remaining** | **int** | Available multi-accounts for use | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateAttributeEnumeration.md 0000644 00000000621 15021222673 0016274 0 ustar 00 # UpdateAttributeEnumeration ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **int** | Id of the value | **label** | **string** | Label of the value | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetWhatsappEventReportEvents.md 0000644 00000002102 15021222673 0016565 0 ustar 00 # GetWhatsappEventReportEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contactNumber** | **string** | WhatsApp Number with country code. Example, 85264318721 | **date** | **string** | UTC date-time on which the event has been generated | **messageId** | **string** | Message ID which generated the event | **event** | **string** | Event which occurred | **reason** | **string** | Reason for the event (will be there in case of `error` and `soft-bounce` events) | [optional] **body** | **string** | Text of the reply (will be there only in case of `reply` event with text) | [optional] **mediaUrl** | **string** | Url of the media reply (will be there only in case of `reply` event with media) | [optional] **senderNumber** | **string** | WhatsApp Number with country code. Example, 85264318721 | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmail.md 0000644 00000011745 15021222673 0013475 0 ustar 00 # SendSmtpEmail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sender** | [**\Brevo\Client\Model\SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional] **to** | [**\Brevo\Client\Model\SendSmtpEmailTo[]**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional] **bcc** | [**\Brevo\Client\Model\SendSmtpEmailBcc[]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] **cc** | [**\Brevo\Client\Model\SendSmtpEmailCc[]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] **htmlContent** | **string** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] **textContent** | **string** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] **subject** | **string** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] **replyTo** | [**\Brevo\Client\Model\SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] **attachment** | [**\Brevo\Client\Model\SendSmtpEmailAttachment[]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] **headers** | **object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\",\"idempotencyKey\":\"abc-123\"}`. | [optional] **templateId** | **int** | Id of the template. | [optional] **params** | **object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] **messageVersions** | [**\Brevo\Client\Model\SendSmtpEmailMessageVersions[]**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails | [optional] **tags** | **string[]** | Tag your emails to find them more easily | [optional] **scheduledAt** | [**\DateTime**] | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional] **batchId** | **string** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/ScheduleSmtpEmail.md 0000644 00000001027 15021222673 0014330 0 ustar 00 # ScheduleSmtpEmail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **messageId** | **string** | Message ID of the transactional email scheduled | [optional] **messageIds** | **string[]** | | [optional] **batchId** | **string** | Batch ID of the batch transactional email scheduled | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedListCampaignStats.md 0000644 00000000676 15021222673 0016504 0 ustar 00 # GetExtendedListCampaignStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign | **stats** | [**\Brevo\Client\Model\GetCampaignStats**](GetCampaignStats.md) | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetCouponCollection.md 0000644 00000001312 15021222673 0014674 0 ustar 00 # GetCouponCollection ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | The id of the collection | **name** | **string** | The name of the collection | **defaultCoupon** | **string** | The default coupon of the collection | **createdAt** | [**\DateTime**](\DateTime.md) | Datetime on which the collection was created | **totalCoupons** | **int** | Total coupons in the collection | **remainingCoupons** | **int** | Not sent coupons in the collection | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedCampaignStatsGlobalStats.md 0000644 00000000502 15021222673 0017774 0 ustar 00 # GetExtendedCampaignStatsGlobalStats ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateEmailCampaignSender.md 0000644 00000001274 15021222673 0015757 0 ustar 00 # UpdateEmailCampaignSender ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Sender Name from which the campaign emails are sent | [optional] **email** | **string** | Sender email from which the campaign emails are sent | [optional] **id** | **int** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetAttributesEnumeration.md 0000644 00000000704 15021222673 0015756 0 ustar 00 # GetAttributesEnumeration ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **int** | ID of Value of the \"category\" type attribute | **label** | **string** | Label of the \"category\" type attribute | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/UpdateBatchContactsModel.md 0000644 00000000617 15021222673 0015630 0 ustar 00 # UpdateBatchContactsModel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **successIds** | **int[]** | | [optional] **failureIds** | **int[]** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetTransacEmailContentEvents.md 0000644 00000000704 15021222673 0016504 0 ustar 00 # GetTransacEmailContentEvents ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **string** | Name of the event that occurred on the sent email | **time** | **string** | Time at which the event occurred | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/InlineResponse2011.md 0000644 00000000531 15021222673 0014220 0 ustar 00 # InlineResponse2011 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **string** | Unique task id | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetSendersListSenders.md 0000644 00000001361 15021222673 0015204 0 ustar 00 # GetSendersListSenders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Id of the sender | **name** | **string** | From Name associated to the sender | **email** | **string** | From Email associated to the sender | **active** | **bool** | Status of sender (true=activated, false=deactivated) | **ips** | [**\Brevo\Client\Model\GetSendersListIps[]**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/GetExtendedContactDetailsStatisticsClicked.md 0000644 00000001105 15021222673 0021331 0 ustar 00 # GetExtendedContactDetailsStatisticsClicked ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **campaignId** | **int** | ID of the campaign which generated the event | **links** | [**\Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[]**](GetExtendedContactDetailsStatisticsLinks.md) | Listing of the clicked links for the campaign | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/docs/Model/SendSmtpEmailCc.md 0000644 00000000725 15021222673 0013737 0 ustar 00 # SendSmtpEmailCc ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **string** | Email address of the recipient in cc | **name** | **string** | Name of the recipient in cc. Maximum allowed characters are 70. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) brevo-php/.travis.yml 0000644 00000000162 15021222673 0010556 0 ustar 00 language: php sudo: false php: - 5.6 - 7.0 before_install: "composer install" script: "vendor/bin/phpunit" brevo-php/composer.lock 0000644 00000217557 15021222673 0011170 0 ustar 00 { "_readme": [ "This file locks the dependencies of your project to a known state", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], "content-hash": "fc3a3187a6ed0508923186df909358ff", "packages": [ { "name": "guzzlehttp/guzzle", "version": "6.3.3", "source": { "type": "git", "url": "https://github.com/guzzle/guzzle.git", "reference": "407b0cb880ace85c9b63c5f9551db498cb2d50ba" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/guzzle/guzzle/zipball/407b0cb880ace85c9b63c5f9551db498cb2d50ba", "reference": "407b0cb880ace85c9b63c5f9551db498cb2d50ba", "shasum": "" }, "require": { "guzzlehttp/promises": "^1.0", "guzzlehttp/psr7": "^1.4", "php": ">=5.5" }, "require-dev": { "ext-curl": "*", "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.4 || ^7.0", "psr/log": "^1.0" }, "suggest": { "psr/log": "Required for using the Log middleware" }, "type": "library", "extra": { "branch-alias": { "dev-master": "6.3-dev" } }, "autoload": { "files": [ "src/functions_include.php" ], "psr-4": { "GuzzleHttp\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Michael Dowling", "email": "mtdowling@gmail.com", "homepage": "https://github.com/mtdowling" } ], "description": "Guzzle is a PHP HTTP client library", "homepage": "http://guzzlephp.org/", "keywords": [ "client", "curl", "framework", "http", "http client", "rest", "web service" ], "time": "2018-04-22T15:46:56+00:00" }, { "name": "guzzlehttp/promises", "version": "v1.3.1", "source": { "type": "git", "url": "https://github.com/guzzle/promises.git", "reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/guzzle/promises/zipball/a59da6cf61d80060647ff4d3eb2c03a2bc694646", "reference": "a59da6cf61d80060647ff4d3eb2c03a2bc694646", "shasum": "" }, "require": { "php": ">=5.5.0" }, "require-dev": { "phpunit/phpunit": "^4.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.4-dev" } }, "autoload": { "psr-4": { "GuzzleHttp\\Promise\\": "src/" }, "files": [ "src/functions_include.php" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Michael Dowling", "email": "mtdowling@gmail.com", "homepage": "https://github.com/mtdowling" } ], "description": "Guzzle promises library", "keywords": [ "promise" ], "time": "2016-12-20T10:07:11+00:00" }, { "name": "guzzlehttp/psr7", "version": "1.5.2", "source": { "type": "git", "url": "https://github.com/guzzle/psr7.git", "reference": "9f83dded91781a01c63574e387eaa769be769115" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/guzzle/psr7/zipball/9f83dded91781a01c63574e387eaa769be769115", "reference": "9f83dded91781a01c63574e387eaa769be769115", "shasum": "" }, "require": { "php": ">=5.4.0", "psr/http-message": "~1.0", "ralouphie/getallheaders": "^2.0.5" }, "provide": { "psr/http-message-implementation": "1.0" }, "require-dev": { "phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.8" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.5-dev" } }, "autoload": { "psr-4": { "GuzzleHttp\\Psr7\\": "src/" }, "files": [ "src/functions_include.php" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Michael Dowling", "email": "mtdowling@gmail.com", "homepage": "https://github.com/mtdowling" }, { "name": "Tobias Schultze", "homepage": "https://github.com/Tobion" } ], "description": "PSR-7 message implementation that also provides common utility methods", "keywords": [ "http", "message", "psr-7", "request", "response", "stream", "uri", "url" ], "time": "2018-12-04T20:46:45+00:00" }, { "name": "psr/http-message", "version": "1.0.1", "source": { "type": "git", "url": "https://github.com/php-fig/http-message.git", "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363", "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363", "shasum": "" }, "require": { "php": ">=5.3.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { "Psr\\Http\\Message\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "PHP-FIG", "homepage": "http://www.php-fig.org/" } ], "description": "Common interface for HTTP messages", "homepage": "https://github.com/php-fig/http-message", "keywords": [ "http", "http-message", "psr", "psr-7", "request", "response" ], "time": "2016-08-06T14:39:51+00:00" }, { "name": "ralouphie/getallheaders", "version": "2.0.5", "source": { "type": "git", "url": "https://github.com/ralouphie/getallheaders.git", "reference": "5601c8a83fbba7ef674a7369456d12f1e0d0eafa" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/5601c8a83fbba7ef674a7369456d12f1e0d0eafa", "reference": "5601c8a83fbba7ef674a7369456d12f1e0d0eafa", "shasum": "" }, "require": { "php": ">=5.3" }, "require-dev": { "phpunit/phpunit": "~3.7.0", "satooshi/php-coveralls": ">=1.0" }, "type": "library", "autoload": { "files": [ "src/getallheaders.php" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Ralph Khattar", "email": "ralph.khattar@gmail.com" } ], "description": "A polyfill for getallheaders.", "time": "2016-02-11T07:05:27+00:00" } ], "packages-dev": [ { "name": "doctrine/instantiator", "version": "1.0.5", "source": { "type": "git", "url": "https://github.com/doctrine/instantiator.git", "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/doctrine/instantiator/zipball/8e884e78f9f0eb1329e445619e04456e64d8051d", "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d", "shasum": "" }, "require": { "php": ">=5.3,<8.0-DEV" }, "require-dev": { "athletic/athletic": "~0.1.8", "ext-pdo": "*", "ext-phar": "*", "phpunit/phpunit": "~4.0", "squizlabs/php_codesniffer": "~2.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { "Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Marco Pivetta", "email": "ocramius@gmail.com", "homepage": "http://ocramius.github.com/" } ], "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", "homepage": "https://github.com/doctrine/instantiator", "keywords": [ "constructor", "instantiate" ], "time": "2015-06-14T21:17:01+00:00" }, { "name": "friendsofphp/php-cs-fixer", "version": "v1.13.3", "source": { "type": "git", "url": "https://github.com/FriendsOfPHP/PHP-CS-Fixer.git", "reference": "387e4c86c9dc0e1e4c475291fc114ec45b98e624" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/FriendsOfPHP/PHP-CS-Fixer/zipball/387e4c86c9dc0e1e4c475291fc114ec45b98e624", "reference": "387e4c86c9dc0e1e4c475291fc114ec45b98e624", "shasum": "" }, "require": { "ext-tokenizer": "*", "php": "^5.3.6 || >=7.0 <7.2", "sebastian/diff": "^1.1", "symfony/console": "^2.3 || ^3.0", "symfony/event-dispatcher": "^2.1 || ^3.0", "symfony/filesystem": "^2.1 || ^3.0", "symfony/finder": "^2.1 || ^3.0", "symfony/process": "^2.3 || ^3.0", "symfony/stopwatch": "^2.5 || ^3.0" }, "conflict": { "hhvm": "<3.9" }, "require-dev": { "phpunit/phpunit": "^4.5|^5", "satooshi/php-coveralls": "^1.0" }, "bin": [ "php-cs-fixer" ], "type": "application", "autoload": { "psr-4": { "Symfony\\CS\\": "Symfony/CS/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Dariusz Rumiński", "email": "dariusz.ruminski@gmail.com" }, { "name": "Fabien Potencier", "email": "fabien@symfony.com" } ], "description": "A tool to automatically fix PHP code style", "time": "2017-09-11T14:11:16+00:00" }, { "name": "phpdocumentor/reflection-common", "version": "1.0.1", "source": { "type": "git", "url": "https://github.com/phpDocumentor/ReflectionCommon.git", "reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6", "reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6", "shasum": "" }, "require": { "php": ">=5.5" }, "require-dev": { "phpunit/phpunit": "^4.6" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { "phpDocumentor\\Reflection\\": [ "src" ] } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Jaap van Otterdijk", "email": "opensource@ijaap.nl" } ], "description": "Common reflection classes used by phpdocumentor to reflect the code structure", "homepage": "http://www.phpdoc.org", "keywords": [ "FQSEN", "phpDocumentor", "phpdoc", "reflection", "static analysis" ], "time": "2017-09-11T18:02:19+00:00" }, { "name": "phpdocumentor/reflection-docblock", "version": "3.3.2", "source": { "type": "git", "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", "reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/bf329f6c1aadea3299f08ee804682b7c45b326a2", "reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2", "shasum": "" }, "require": { "php": "^5.6 || ^7.0", "phpdocumentor/reflection-common": "^1.0.0", "phpdocumentor/type-resolver": "^0.4.0", "webmozart/assert": "^1.0" }, "require-dev": { "mockery/mockery": "^0.9.4", "phpunit/phpunit": "^4.4" }, "type": "library", "autoload": { "psr-4": { "phpDocumentor\\Reflection\\": [ "src/" ] } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Mike van Riel", "email": "me@mikevanriel.com" } ], "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", "time": "2017-11-10T14:09:06+00:00" }, { "name": "phpdocumentor/type-resolver", "version": "0.4.0", "source": { "type": "git", "url": "https://github.com/phpDocumentor/TypeResolver.git", "reference": "9c977708995954784726e25d0cd1dddf4e65b0f7" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/9c977708995954784726e25d0cd1dddf4e65b0f7", "reference": "9c977708995954784726e25d0cd1dddf4e65b0f7", "shasum": "" }, "require": { "php": "^5.5 || ^7.0", "phpdocumentor/reflection-common": "^1.0" }, "require-dev": { "mockery/mockery": "^0.9.4", "phpunit/phpunit": "^5.2||^4.8.24" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { "phpDocumentor\\Reflection\\": [ "src/" ] } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Mike van Riel", "email": "me@mikevanriel.com" } ], "time": "2017-07-14T14:27:02+00:00" }, { "name": "phpspec/prophecy", "version": "1.8.0", "source": { "type": "git", "url": "https://github.com/phpspec/prophecy.git", "reference": "4ba436b55987b4bf311cb7c6ba82aa528aac0a06" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/phpspec/prophecy/zipball/4ba436b55987b4bf311cb7c6ba82aa528aac0a06", "reference": "4ba436b55987b4bf311cb7c6ba82aa528aac0a06", "shasum": "" }, "require": { "doctrine/instantiator": "^1.0.2", "php": "^5.3|^7.0", "phpdocumentor/reflection-docblock": "^2.0|^3.0.2|^4.0", "sebastian/comparator": "^1.1|^2.0|^3.0", "sebastian/recursion-context": "^1.0|^2.0|^3.0" }, "require-dev": { "phpspec/phpspec": "^2.5|^3.2", "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5 || ^7.1" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.8.x-dev" } }, "autoload": { "psr-0": { "Prophecy\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Konstantin Kudryashov", "email": "ever.zet@gmail.com", "homepage": "http://everzet.com" }, { "name": "Marcello Duarte", "email": "marcello.duarte@gmail.com" } ], "description": "Highly opinionated mocking framework for PHP 5.3+", "homepage": "https://github.com/phpspec/prophecy", "keywords": [ "Double", "Dummy", "fake", "mock", "spy", "stub" ], "time": "2018-08-05T17:53:17+00:00" }, { "name": "phpunit/php-code-coverage", "version": "2.2.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", "reference": "eabf68b476ac7d0f73793aada060f1c1a9bf8979" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/eabf68b476ac7d0f73793aada060f1c1a9bf8979", "reference": "eabf68b476ac7d0f73793aada060f1c1a9bf8979", "shasum": "" }, "require": { "php": ">=5.3.3", "phpunit/php-file-iterator": "~1.3", "phpunit/php-text-template": "~1.2", "phpunit/php-token-stream": "~1.3", "sebastian/environment": "^1.3.2", "sebastian/version": "~1.0" }, "require-dev": { "ext-xdebug": ">=2.1.4", "phpunit/phpunit": "~4" }, "suggest": { "ext-dom": "*", "ext-xdebug": ">=2.2.1", "ext-xmlwriter": "*" }, "type": "library", "extra": { "branch-alias": { "dev-master": "2.2.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", "homepage": "https://github.com/sebastianbergmann/php-code-coverage", "keywords": [ "coverage", "testing", "xunit" ], "time": "2015-10-06T15:47:00+00:00" }, { "name": "phpunit/php-file-iterator", "version": "1.4.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4", "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.4.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "FilterIterator implementation that filters files based on a list of suffixes.", "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", "keywords": [ "filesystem", "iterator" ], "time": "2017-11-27T13:52:08+00:00" }, { "name": "phpunit/php-text-template", "version": "1.2.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-text-template.git", "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/31f8b717e51d9a2afca6c9f046f5d69fc27c8686", "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686", "shasum": "" }, "require": { "php": ">=5.3.3" }, "type": "library", "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de", "role": "lead" } ], "description": "Simple template engine.", "homepage": "https://github.com/sebastianbergmann/php-text-template/", "keywords": [ "template" ], "time": "2015-06-21T13:50:34+00:00" }, { "name": "phpunit/php-timer", "version": "1.0.9", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", "shasum": "" }, "require": { "php": "^5.3.3 || ^7.0" }, "require-dev": { "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Utility class for timing", "homepage": "https://github.com/sebastianbergmann/php-timer/", "keywords": [ "timer" ], "time": "2017-02-26T11:10:40+00:00" }, { "name": "phpunit/php-token-stream", "version": "1.4.12", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-token-stream.git", "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/1ce90ba27c42e4e44e6d8458241466380b51fa16", "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16", "shasum": "" }, "require": { "ext-tokenizer": "*", "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.2" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.4-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Wrapper around PHP's tokenizer extension.", "homepage": "https://github.com/sebastianbergmann/php-token-stream/", "keywords": [ "tokenizer" ], "time": "2017-12-04T08:55:13+00:00" }, { "name": "phpunit/phpunit", "version": "4.8.36", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", "reference": "46023de9a91eec7dfb06cc56cb4e260017298517" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/46023de9a91eec7dfb06cc56cb4e260017298517", "reference": "46023de9a91eec7dfb06cc56cb4e260017298517", "shasum": "" }, "require": { "ext-dom": "*", "ext-json": "*", "ext-pcre": "*", "ext-reflection": "*", "ext-spl": "*", "php": ">=5.3.3", "phpspec/prophecy": "^1.3.1", "phpunit/php-code-coverage": "~2.1", "phpunit/php-file-iterator": "~1.4", "phpunit/php-text-template": "~1.2", "phpunit/php-timer": "^1.0.6", "phpunit/phpunit-mock-objects": "~2.3", "sebastian/comparator": "~1.2.2", "sebastian/diff": "~1.2", "sebastian/environment": "~1.3", "sebastian/exporter": "~1.2", "sebastian/global-state": "~1.0", "sebastian/version": "~1.0", "symfony/yaml": "~2.1|~3.0" }, "suggest": { "phpunit/php-invoker": "~1.1" }, "bin": [ "phpunit" ], "type": "library", "extra": { "branch-alias": { "dev-master": "4.8.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de", "role": "lead" } ], "description": "The PHP Unit Testing framework.", "homepage": "https://phpunit.de/", "keywords": [ "phpunit", "testing", "xunit" ], "time": "2017-06-21T08:07:12+00:00" }, { "name": "phpunit/phpunit-mock-objects", "version": "2.3.8", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", "reference": "ac8e7a3db35738d56ee9a76e78a4e03d97628983" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/ac8e7a3db35738d56ee9a76e78a4e03d97628983", "reference": "ac8e7a3db35738d56ee9a76e78a4e03d97628983", "shasum": "" }, "require": { "doctrine/instantiator": "^1.0.2", "php": ">=5.3.3", "phpunit/php-text-template": "~1.2", "sebastian/exporter": "~1.2" }, "require-dev": { "phpunit/phpunit": "~4.4" }, "suggest": { "ext-soap": "*" }, "type": "library", "extra": { "branch-alias": { "dev-master": "2.3.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sb@sebastian-bergmann.de", "role": "lead" } ], "description": "Mock Object library for PHPUnit", "homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/", "keywords": [ "mock", "xunit" ], "abandoned": true, "time": "2015-10-02T06:51:40+00:00" }, { "name": "psr/log", "version": "1.1.0", "source": { "type": "git", "url": "https://github.com/php-fig/log.git", "reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/php-fig/log/zipball/6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd", "reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd", "shasum": "" }, "require": { "php": ">=5.3.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "psr-4": { "Psr\\Log\\": "Psr/Log/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "PHP-FIG", "homepage": "http://www.php-fig.org/" } ], "description": "Common interface for logging libraries", "homepage": "https://github.com/php-fig/log", "keywords": [ "log", "psr", "psr-3" ], "time": "2018-11-20T15:27:04+00:00" }, { "name": "sebastian/comparator", "version": "1.2.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", "shasum": "" }, "require": { "php": ">=5.3.3", "sebastian/diff": "~1.2", "sebastian/exporter": "~1.2 || ~2.0" }, "require-dev": { "phpunit/phpunit": "~4.4" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.2.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, { "name": "Volker Dusch", "email": "github@wallbash.com" }, { "name": "Bernhard Schussek", "email": "bschussek@2bepublished.at" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Provides the functionality to compare PHP values for equality", "homepage": "http://www.github.com/sebastianbergmann/comparator", "keywords": [ "comparator", "compare", "equality" ], "time": "2017-01-29T09:50:25+00:00" }, { "name": "sebastian/diff", "version": "1.4.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7f066a26a962dbe58ddea9f72a4e82874a3975a4", "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4", "shasum": "" }, "require": { "php": "^5.3.3 || ^7.0" }, "require-dev": { "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.4-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Kore Nordmann", "email": "mail@kore-nordmann.de" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Diff implementation", "homepage": "https://github.com/sebastianbergmann/diff", "keywords": [ "diff" ], "time": "2017-05-22T07:24:03+00:00" }, { "name": "sebastian/environment", "version": "1.3.8", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/environment.git", "reference": "be2c607e43ce4c89ecd60e75c6a85c126e754aea" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/be2c607e43ce4c89ecd60e75c6a85c126e754aea", "reference": "be2c607e43ce4c89ecd60e75c6a85c126e754aea", "shasum": "" }, "require": { "php": "^5.3.3 || ^7.0" }, "require-dev": { "phpunit/phpunit": "^4.8 || ^5.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.3.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Provides functionality to handle HHVM/PHP environments", "homepage": "http://www.github.com/sebastianbergmann/environment", "keywords": [ "Xdebug", "environment", "hhvm" ], "time": "2016-08-18T05:49:44+00:00" }, { "name": "sebastian/exporter", "version": "1.2.2", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/42c4c2eec485ee3e159ec9884f95b431287edde4", "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4", "shasum": "" }, "require": { "php": ">=5.3.3", "sebastian/recursion-context": "~1.0" }, "require-dev": { "ext-mbstring": "*", "phpunit/phpunit": "~4.4" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.3.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, { "name": "Volker Dusch", "email": "github@wallbash.com" }, { "name": "Bernhard Schussek", "email": "bschussek@2bepublished.at" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" }, { "name": "Adam Harvey", "email": "aharvey@php.net" } ], "description": "Provides the functionality to export PHP variables for visualization", "homepage": "http://www.github.com/sebastianbergmann/exporter", "keywords": [ "export", "exporter" ], "time": "2016-06-17T09:04:28+00:00" }, { "name": "sebastian/global-state", "version": "1.1.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/global-state.git", "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/bc37d50fea7d017d3d340f230811c9f1d7280af4", "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.2" }, "suggest": { "ext-uopz": "*" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" } ], "description": "Snapshotting of global state", "homepage": "http://www.github.com/sebastianbergmann/global-state", "keywords": [ "global state" ], "time": "2015-10-12T03:26:01+00:00" }, { "name": "sebastian/recursion-context", "version": "1.0.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/recursion-context.git", "reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/b19cc3298482a335a95f3016d2f8a6950f0fbcd7", "reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7", "shasum": "" }, "require": { "php": ">=5.3.3" }, "require-dev": { "phpunit/phpunit": "~4.4" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } }, "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" }, { "name": "Adam Harvey", "email": "aharvey@php.net" } ], "description": "Provides functionality to recursively process PHP variables", "homepage": "http://www.github.com/sebastianbergmann/recursion-context", "time": "2016-10-03T07:41:43+00:00" }, { "name": "sebastian/version", "version": "1.0.6", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/version.git", "reference": "58b3a85e7999757d6ad81c787a1fbf5ff6c628c6" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/58b3a85e7999757d6ad81c787a1fbf5ff6c628c6", "reference": "58b3a85e7999757d6ad81c787a1fbf5ff6c628c6", "shasum": "" }, "type": "library", "autoload": { "classmap": [ "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de", "role": "lead" } ], "description": "Library that helps with managing the version number of Git-hosted PHP projects", "homepage": "https://github.com/sebastianbergmann/version", "time": "2015-06-21T13:59:46+00:00" }, { "name": "squizlabs/php_codesniffer", "version": "2.9.2", "source": { "type": "git", "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", "reference": "2acf168de78487db620ab4bc524135a13cfe6745" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/2acf168de78487db620ab4bc524135a13cfe6745", "reference": "2acf168de78487db620ab4bc524135a13cfe6745", "shasum": "" }, "require": { "ext-simplexml": "*", "ext-tokenizer": "*", "ext-xmlwriter": "*", "php": ">=5.1.2" }, "require-dev": { "phpunit/phpunit": "~4.0" }, "bin": [ "scripts/phpcs", "scripts/phpcbf" ], "type": "library", "extra": { "branch-alias": { "dev-master": "2.x-dev" } }, "autoload": { "classmap": [ "CodeSniffer.php", "CodeSniffer/CLI.php", "CodeSniffer/Exception.php", "CodeSniffer/File.php", "CodeSniffer/Fixer.php", "CodeSniffer/Report.php", "CodeSniffer/Reporting.php", "CodeSniffer/Sniff.php", "CodeSniffer/Tokens.php", "CodeSniffer/Reports/", "CodeSniffer/Tokenizers/", "CodeSniffer/DocGenerators/", "CodeSniffer/Standards/AbstractPatternSniff.php", "CodeSniffer/Standards/AbstractScopeSniff.php", "CodeSniffer/Standards/AbstractVariableSniff.php", "CodeSniffer/Standards/IncorrectPatternException.php", "CodeSniffer/Standards/Generic/Sniffs/", "CodeSniffer/Standards/MySource/Sniffs/", "CodeSniffer/Standards/PEAR/Sniffs/", "CodeSniffer/Standards/PSR1/Sniffs/", "CodeSniffer/Standards/PSR2/Sniffs/", "CodeSniffer/Standards/Squiz/Sniffs/", "CodeSniffer/Standards/Zend/Sniffs/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { "name": "Greg Sherwood", "role": "lead" } ], "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", "homepage": "http://www.squizlabs.com/php-codesniffer", "keywords": [ "phpcs", "standards" ], "time": "2018-11-07T22:31:41+00:00" }, { "name": "symfony/console", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/console.git", "reference": "15a9104356436cb26e08adab97706654799d31d8" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/console/zipball/15a9104356436cb26e08adab97706654799d31d8", "reference": "15a9104356436cb26e08adab97706654799d31d8", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8", "symfony/debug": "~2.8|~3.0|~4.0", "symfony/polyfill-mbstring": "~1.0" }, "conflict": { "symfony/dependency-injection": "<3.4", "symfony/process": "<3.3" }, "provide": { "psr/log-implementation": "1.0" }, "require-dev": { "psr/log": "~1.0", "symfony/config": "~3.3|~4.0", "symfony/dependency-injection": "~3.4|~4.0", "symfony/event-dispatcher": "~2.8|~3.0|~4.0", "symfony/lock": "~3.4|~4.0", "symfony/process": "~3.3|~4.0" }, "suggest": { "psr/log": "For using the console logger", "symfony/event-dispatcher": "", "symfony/lock": "", "symfony/process": "" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Console\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Console Component", "homepage": "https://symfony.com", "time": "2019-04-08T09:29:13+00:00" }, { "name": "symfony/debug", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/debug.git", "reference": "681afbb26488903c5ac15e63734f1d8ac430c9b9" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/debug/zipball/681afbb26488903c5ac15e63734f1d8ac430c9b9", "reference": "681afbb26488903c5ac15e63734f1d8ac430c9b9", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8", "psr/log": "~1.0" }, "conflict": { "symfony/http-kernel": ">=2.3,<2.3.24|~2.4.0|>=2.5,<2.5.9|>=2.6,<2.6.2" }, "require-dev": { "symfony/http-kernel": "~2.8|~3.0|~4.0" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Debug\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Debug Component", "homepage": "https://symfony.com", "time": "2019-04-11T09:48:14+00:00" }, { "name": "symfony/event-dispatcher", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/event-dispatcher.git", "reference": "a088aafcefb4eef2520a290ed82e4374092a6dff" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/a088aafcefb4eef2520a290ed82e4374092a6dff", "reference": "a088aafcefb4eef2520a290ed82e4374092a6dff", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8" }, "conflict": { "symfony/dependency-injection": "<3.3" }, "require-dev": { "psr/log": "~1.0", "symfony/config": "~2.8|~3.0|~4.0", "symfony/dependency-injection": "~3.3|~4.0", "symfony/expression-language": "~2.8|~3.0|~4.0", "symfony/stopwatch": "~2.8|~3.0|~4.0" }, "suggest": { "symfony/dependency-injection": "", "symfony/http-kernel": "" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\EventDispatcher\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony EventDispatcher Component", "homepage": "https://symfony.com", "time": "2019-04-02T08:51:52+00:00" }, { "name": "symfony/filesystem", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/filesystem.git", "reference": "acf99758b1df8e9295e6b85aa69f294565c9fedb" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/filesystem/zipball/acf99758b1df8e9295e6b85aa69f294565c9fedb", "reference": "acf99758b1df8e9295e6b85aa69f294565c9fedb", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8", "symfony/polyfill-ctype": "~1.8" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Filesystem\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Filesystem Component", "homepage": "https://symfony.com", "time": "2019-02-04T21:34:32+00:00" }, { "name": "symfony/finder", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/finder.git", "reference": "61af5ce0b34b942d414fe8f1b11950d0e9a90e98" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/finder/zipball/61af5ce0b34b942d414fe8f1b11950d0e9a90e98", "reference": "61af5ce0b34b942d414fe8f1b11950d0e9a90e98", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Finder\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Finder Component", "homepage": "https://symfony.com", "time": "2019-04-02T19:54:57+00:00" }, { "name": "symfony/polyfill-ctype", "version": "v1.11.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-ctype.git", "reference": "82ebae02209c21113908c229e9883c419720738a" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/82ebae02209c21113908c229e9883c419720738a", "reference": "82ebae02209c21113908c229e9883c419720738a", "shasum": "" }, "require": { "php": ">=5.3.3" }, "suggest": { "ext-ctype": "For best performance" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.11-dev" } }, "autoload": { "psr-4": { "Symfony\\Polyfill\\Ctype\\": "" }, "files": [ "bootstrap.php" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" }, { "name": "Gert de Pagter", "email": "backendtea@gmail.com" } ], "description": "Symfony polyfill for ctype functions", "homepage": "https://symfony.com", "keywords": [ "compatibility", "ctype", "polyfill", "portable" ], "time": "2019-02-06T07:57:58+00:00" }, { "name": "symfony/polyfill-mbstring", "version": "v1.11.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", "reference": "fe5e94c604826c35a32fa832f35bd036b6799609" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/fe5e94c604826c35a32fa832f35bd036b6799609", "reference": "fe5e94c604826c35a32fa832f35bd036b6799609", "shasum": "" }, "require": { "php": ">=5.3.3" }, "suggest": { "ext-mbstring": "For best performance" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.11-dev" } }, "autoload": { "psr-4": { "Symfony\\Polyfill\\Mbstring\\": "" }, "files": [ "bootstrap.php" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Nicolas Grekas", "email": "p@tchwork.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony polyfill for the Mbstring extension", "homepage": "https://symfony.com", "keywords": [ "compatibility", "mbstring", "polyfill", "portable", "shim" ], "time": "2019-02-06T07:57:58+00:00" }, { "name": "symfony/process", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/process.git", "reference": "a9c4dfbf653023b668c282e4e02609d131f4057a" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/process/zipball/a9c4dfbf653023b668c282e4e02609d131f4057a", "reference": "a9c4dfbf653023b668c282e4e02609d131f4057a", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Process\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Process Component", "homepage": "https://symfony.com", "time": "2019-04-08T16:15:54+00:00" }, { "name": "symfony/stopwatch", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/stopwatch.git", "reference": "2a651c2645c10bbedd21170771f122d935e0dd58" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/stopwatch/zipball/2a651c2645c10bbedd21170771f122d935e0dd58", "reference": "2a651c2645c10bbedd21170771f122d935e0dd58", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Stopwatch\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Stopwatch Component", "homepage": "https://symfony.com", "time": "2019-01-16T09:39:14+00:00" }, { "name": "symfony/yaml", "version": "v3.4.26", "source": { "type": "git", "url": "https://github.com/symfony/yaml.git", "reference": "212a27b731e5bfb735679d1ffaac82bd6a1dc996" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/symfony/yaml/zipball/212a27b731e5bfb735679d1ffaac82bd6a1dc996", "reference": "212a27b731e5bfb735679d1ffaac82bd6a1dc996", "shasum": "" }, "require": { "php": "^5.5.9|>=7.0.8", "symfony/polyfill-ctype": "~1.8" }, "conflict": { "symfony/console": "<3.4" }, "require-dev": { "symfony/console": "~3.4|~4.0" }, "suggest": { "symfony/console": "For validating YAML files using the lint command" }, "type": "library", "extra": { "branch-alias": { "dev-master": "3.4-dev" } }, "autoload": { "psr-4": { "Symfony\\Component\\Yaml\\": "" }, "exclude-from-classmap": [ "/Tests/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Fabien Potencier", "email": "fabien@symfony.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], "description": "Symfony Yaml Component", "homepage": "https://symfony.com", "time": "2019-03-25T07:48:46+00:00" }, { "name": "webmozart/assert", "version": "1.4.0", "source": { "type": "git", "url": "https://github.com/webmozart/assert.git", "reference": "83e253c8e0be5b0257b881e1827274667c5c17a9" }, "dist": { "type": "zip", "url": "https://api.github.com/repos/webmozart/assert/zipball/83e253c8e0be5b0257b881e1827274667c5c17a9", "reference": "83e253c8e0be5b0257b881e1827274667c5c17a9", "shasum": "" }, "require": { "php": "^5.3.3 || ^7.0", "symfony/polyfill-ctype": "^1.8" }, "require-dev": { "phpunit/phpunit": "^4.6", "sebastian/version": "^1.0.1" }, "type": "library", "extra": { "branch-alias": { "dev-master": "1.3-dev" } }, "autoload": { "psr-4": { "Webmozart\\Assert\\": "src/" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], "authors": [ { "name": "Bernhard Schussek", "email": "bschussek@gmail.com" } ], "description": "Assertions to validate method input/output with nice error messages.", "keywords": [ "assert", "check", "validate" ], "time": "2018-12-25T11:19:39+00:00" } ], "aliases": [], "minimum-stability": "stable", "stability-flags": [], "prefer-stable": false, "prefer-lowest": false, "platform": { "php": ">=5.6", "ext-curl": "*", "ext-json": "*", "ext-mbstring": "*" }, "platform-dev": [] } brevo-php/lib/Api/EmailCampaignsApi.php 0000644 00000431620 15021222673 0013750 0 ustar 00 <?php /** * EmailCampaignsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * EmailCampaignsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EmailCampaignsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createEmailCampaign * * Create an email campaign * * @param \Brevo\Client\Model\CreateEmailCampaign $emailCampaigns Values to create a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createEmailCampaign($emailCampaigns) { list($response) = $this->createEmailCampaignWithHttpInfo($emailCampaigns); return $response; } /** * Operation createEmailCampaignWithHttpInfo * * Create an email campaign * * @param \Brevo\Client\Model\CreateEmailCampaign $emailCampaigns Values to create a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createEmailCampaignWithHttpInfo($emailCampaigns) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createEmailCampaignRequest($emailCampaigns); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createEmailCampaignAsync * * Create an email campaign * * @param \Brevo\Client\Model\CreateEmailCampaign $emailCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createEmailCampaignAsync($emailCampaigns) { return $this->createEmailCampaignAsyncWithHttpInfo($emailCampaigns) ->then( function ($response) { return $response[0]; } ); } /** * Operation createEmailCampaignAsyncWithHttpInfo * * Create an email campaign * * @param \Brevo\Client\Model\CreateEmailCampaign $emailCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createEmailCampaignAsyncWithHttpInfo($emailCampaigns) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createEmailCampaignRequest($emailCampaigns); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createEmailCampaign' * * @param \Brevo\Client\Model\CreateEmailCampaign $emailCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createEmailCampaignRequest($emailCampaigns) { // verify the required parameter 'emailCampaigns' is set if ($emailCampaigns === null || (is_array($emailCampaigns) && count($emailCampaigns) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $emailCampaigns when calling createEmailCampaign' ); } $resourcePath = '/emailCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($emailCampaigns)) { $_tempBody = $emailCampaigns; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteEmailCampaign * * Delete an email campaign * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteEmailCampaign($campaignId) { $this->deleteEmailCampaignWithHttpInfo($campaignId); } /** * Operation deleteEmailCampaignWithHttpInfo * * Delete an email campaign * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteEmailCampaignWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteEmailCampaignRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteEmailCampaignAsync * * Delete an email campaign * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteEmailCampaignAsync($campaignId) { return $this->deleteEmailCampaignAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteEmailCampaignAsyncWithHttpInfo * * Delete an email campaign * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteEmailCampaignAsyncWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteEmailCampaignRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteEmailCampaign' * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteEmailCampaignRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling deleteEmailCampaign' ); } $resourcePath = '/emailCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation emailExportRecipients * * Export the recipients of an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\EmailExportRecipients $recipientExport Values to send for a recipient export request (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreatedProcessId */ public function emailExportRecipients($campaignId, $recipientExport = null) { list($response) = $this->emailExportRecipientsWithHttpInfo($campaignId, $recipientExport); return $response; } /** * Operation emailExportRecipientsWithHttpInfo * * Export the recipients of an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\EmailExportRecipients $recipientExport Values to send for a recipient export request (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ public function emailExportRecipientsWithHttpInfo($campaignId, $recipientExport = null) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->emailExportRecipientsRequest($campaignId, $recipientExport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreatedProcessId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation emailExportRecipientsAsync * * Export the recipients of an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\EmailExportRecipients $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function emailExportRecipientsAsync($campaignId, $recipientExport = null) { return $this->emailExportRecipientsAsyncWithHttpInfo($campaignId, $recipientExport) ->then( function ($response) { return $response[0]; } ); } /** * Operation emailExportRecipientsAsyncWithHttpInfo * * Export the recipients of an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\EmailExportRecipients $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function emailExportRecipientsAsyncWithHttpInfo($campaignId, $recipientExport = null) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->emailExportRecipientsRequest($campaignId, $recipientExport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'emailExportRecipients' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\EmailExportRecipients $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function emailExportRecipientsRequest($campaignId, $recipientExport = null) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling emailExportRecipients' ); } $resourcePath = '/emailCampaigns/{campaignId}/exportRecipients'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($recipientExport)) { $_tempBody = $recipientExport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAbTestCampaignResult * * Get an A/B test email campaign results * * @param int $campaignId Id of the A/B test campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\AbTestCampaignResult */ public function getAbTestCampaignResult($campaignId) { list($response) = $this->getAbTestCampaignResultWithHttpInfo($campaignId); return $response; } /** * Operation getAbTestCampaignResultWithHttpInfo * * Get an A/B test email campaign results * * @param int $campaignId Id of the A/B test campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\AbTestCampaignResult, HTTP status code, HTTP response headers (array of strings) */ public function getAbTestCampaignResultWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\AbTestCampaignResult'; $request = $this->getAbTestCampaignResultRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\AbTestCampaignResult', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 405: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAbTestCampaignResultAsync * * Get an A/B test email campaign results * * @param int $campaignId Id of the A/B test campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAbTestCampaignResultAsync($campaignId) { return $this->getAbTestCampaignResultAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getAbTestCampaignResultAsyncWithHttpInfo * * Get an A/B test email campaign results * * @param int $campaignId Id of the A/B test campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAbTestCampaignResultAsyncWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\AbTestCampaignResult'; $request = $this->getAbTestCampaignResultRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAbTestCampaignResult' * * @param int $campaignId Id of the A/B test campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAbTestCampaignResultRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling getAbTestCampaignResult' ); } $resourcePath = '/emailCampaigns/{campaignId}/abTestCampaignResult'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getEmailCampaign * * Get an email campaign report * * @param int $campaignId Id of the campaign (required) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetEmailCampaign */ public function getEmailCampaign($campaignId, $statistics = null) { list($response) = $this->getEmailCampaignWithHttpInfo($campaignId, $statistics); return $response; } /** * Operation getEmailCampaignWithHttpInfo * * Get an email campaign report * * @param int $campaignId Id of the campaign (required) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetEmailCampaign, HTTP status code, HTTP response headers (array of strings) */ public function getEmailCampaignWithHttpInfo($campaignId, $statistics = null) { $returnType = '\Brevo\Client\Model\GetEmailCampaign'; $request = $this->getEmailCampaignRequest($campaignId, $statistics); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetEmailCampaign', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getEmailCampaignAsync * * Get an email campaign report * * @param int $campaignId Id of the campaign (required) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailCampaignAsync($campaignId, $statistics = null) { return $this->getEmailCampaignAsyncWithHttpInfo($campaignId, $statistics) ->then( function ($response) { return $response[0]; } ); } /** * Operation getEmailCampaignAsyncWithHttpInfo * * Get an email campaign report * * @param int $campaignId Id of the campaign (required) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailCampaignAsyncWithHttpInfo($campaignId, $statistics = null) { $returnType = '\Brevo\Client\Model\GetEmailCampaign'; $request = $this->getEmailCampaignRequest($campaignId, $statistics); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getEmailCampaign' * * @param int $campaignId Id of the campaign (required) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getEmailCampaignRequest($campaignId, $statistics = null) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling getEmailCampaign' ); } $resourcePath = '/emailCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($statistics !== null) { $queryParams['statistics'] = ObjectSerializer::toQueryValue($statistics); } // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getEmailCampaigns * * Return all your created email campaigns * * @param string $type Filter on the type of the campaigns (optional) * @param string $status Filter on the status of the campaign (optional) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param bool $excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetEmailCampaigns */ public function getEmailCampaigns($type = null, $status = null, $statistics = null, $startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc', $excludeHtmlContent = null) { list($response) = $this->getEmailCampaignsWithHttpInfo($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent); return $response; } /** * Operation getEmailCampaignsWithHttpInfo * * Return all your created email campaigns * * @param string $type Filter on the type of the campaigns (optional) * @param string $status Filter on the status of the campaign (optional) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param bool $excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetEmailCampaigns, HTTP status code, HTTP response headers (array of strings) */ public function getEmailCampaignsWithHttpInfo($type = null, $status = null, $statistics = null, $startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc', $excludeHtmlContent = null) { $returnType = '\Brevo\Client\Model\GetEmailCampaigns'; $request = $this->getEmailCampaignsRequest($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetEmailCampaigns', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getEmailCampaignsAsync * * Return all your created email campaigns * * @param string $type Filter on the type of the campaigns (optional) * @param string $status Filter on the status of the campaign (optional) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param bool $excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailCampaignsAsync($type = null, $status = null, $statistics = null, $startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc', $excludeHtmlContent = null) { return $this->getEmailCampaignsAsyncWithHttpInfo($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent) ->then( function ($response) { return $response[0]; } ); } /** * Operation getEmailCampaignsAsyncWithHttpInfo * * Return all your created email campaigns * * @param string $type Filter on the type of the campaigns (optional) * @param string $status Filter on the status of the campaign (optional) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param bool $excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailCampaignsAsyncWithHttpInfo($type = null, $status = null, $statistics = null, $startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc', $excludeHtmlContent = null) { $returnType = '\Brevo\Client\Model\GetEmailCampaigns'; $request = $this->getEmailCampaignsRequest($type, $status, $statistics, $startDate, $endDate, $limit, $offset, $sort, $excludeHtmlContent); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getEmailCampaigns' * * @param string $type Filter on the type of the campaigns (optional) * @param string $status Filter on the status of the campaign (optional) * @param string $statistics Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param bool $excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getEmailCampaignsRequest($type = null, $status = null, $statistics = null, $startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc', $excludeHtmlContent = null) { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling EmailCampaignsApi.getEmailCampaigns, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling EmailCampaignsApi.getEmailCampaigns, must be bigger than or equal to 0.'); } $resourcePath = '/emailCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($type !== null) { $queryParams['type'] = ObjectSerializer::toQueryValue($type); } // query params if ($status !== null) { $queryParams['status'] = ObjectSerializer::toQueryValue($status); } // query params if ($statistics !== null) { $queryParams['statistics'] = ObjectSerializer::toQueryValue($statistics); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($excludeHtmlContent !== null) { $queryParams['excludeHtmlContent'] = ObjectSerializer::toQueryValue($excludeHtmlContent); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSharedTemplateUrl * * Get a shared template url * * @param int $campaignId Id of the campaign or template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSharedTemplateUrl */ public function getSharedTemplateUrl($campaignId) { list($response) = $this->getSharedTemplateUrlWithHttpInfo($campaignId); return $response; } /** * Operation getSharedTemplateUrlWithHttpInfo * * Get a shared template url * * @param int $campaignId Id of the campaign or template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSharedTemplateUrl, HTTP status code, HTTP response headers (array of strings) */ public function getSharedTemplateUrlWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetSharedTemplateUrl'; $request = $this->getSharedTemplateUrlRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSharedTemplateUrl', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSharedTemplateUrlAsync * * Get a shared template url * * @param int $campaignId Id of the campaign or template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSharedTemplateUrlAsync($campaignId) { return $this->getSharedTemplateUrlAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSharedTemplateUrlAsyncWithHttpInfo * * Get a shared template url * * @param int $campaignId Id of the campaign or template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSharedTemplateUrlAsyncWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetSharedTemplateUrl'; $request = $this->getSharedTemplateUrlRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSharedTemplateUrl' * * @param int $campaignId Id of the campaign or template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSharedTemplateUrlRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling getSharedTemplateUrl' ); } $resourcePath = '/emailCampaigns/{campaignId}/sharedUrl'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendEmailCampaignNow * * Send an email campaign immediately, based on campaignId * * @param int $campaignId Id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendEmailCampaignNow($campaignId) { $this->sendEmailCampaignNowWithHttpInfo($campaignId); } /** * Operation sendEmailCampaignNowWithHttpInfo * * Send an email campaign immediately, based on campaignId * * @param int $campaignId Id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendEmailCampaignNowWithHttpInfo($campaignId) { $returnType = ''; $request = $this->sendEmailCampaignNowRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 402: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendEmailCampaignNowAsync * * Send an email campaign immediately, based on campaignId * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendEmailCampaignNowAsync($campaignId) { return $this->sendEmailCampaignNowAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendEmailCampaignNowAsyncWithHttpInfo * * Send an email campaign immediately, based on campaignId * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendEmailCampaignNowAsyncWithHttpInfo($campaignId) { $returnType = ''; $request = $this->sendEmailCampaignNowRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendEmailCampaignNow' * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendEmailCampaignNowRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendEmailCampaignNow' ); } $resourcePath = '/emailCampaigns/{campaignId}/sendNow'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendReport * * Send the report of a campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendReport($campaignId, $sendReport) { $this->sendReportWithHttpInfo($campaignId, $sendReport); } /** * Operation sendReportWithHttpInfo * * Send the report of a campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendReportWithHttpInfo($campaignId, $sendReport) { $returnType = ''; $request = $this->sendReportRequest($campaignId, $sendReport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendReportAsync * * Send the report of a campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendReportAsync($campaignId, $sendReport) { return $this->sendReportAsyncWithHttpInfo($campaignId, $sendReport) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendReportAsyncWithHttpInfo * * Send the report of a campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendReportAsyncWithHttpInfo($campaignId, $sendReport) { $returnType = ''; $request = $this->sendReportRequest($campaignId, $sendReport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendReport' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendReportRequest($campaignId, $sendReport) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendReport' ); } // verify the required parameter 'sendReport' is set if ($sendReport === null || (is_array($sendReport) && count($sendReport) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendReport when calling sendReport' ); } $resourcePath = '/emailCampaigns/{campaignId}/sendReport'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($sendReport)) { $_tempBody = $sendReport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendTestEmail * * Send an email campaign to your test list * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendTestEmail $emailTo emailTo (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendTestEmail($campaignId, $emailTo) { $this->sendTestEmailWithHttpInfo($campaignId, $emailTo); } /** * Operation sendTestEmailWithHttpInfo * * Send an email campaign to your test list * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendTestEmail $emailTo (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendTestEmailWithHttpInfo($campaignId, $emailTo) { $returnType = ''; $request = $this->sendTestEmailRequest($campaignId, $emailTo); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostSendFailed', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendTestEmailAsync * * Send an email campaign to your test list * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendTestEmail $emailTo (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestEmailAsync($campaignId, $emailTo) { return $this->sendTestEmailAsyncWithHttpInfo($campaignId, $emailTo) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendTestEmailAsyncWithHttpInfo * * Send an email campaign to your test list * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendTestEmail $emailTo (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestEmailAsyncWithHttpInfo($campaignId, $emailTo) { $returnType = ''; $request = $this->sendTestEmailRequest($campaignId, $emailTo); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendTestEmail' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\SendTestEmail $emailTo (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendTestEmailRequest($campaignId, $emailTo) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendTestEmail' ); } // verify the required parameter 'emailTo' is set if ($emailTo === null || (is_array($emailTo) && count($emailTo) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $emailTo when calling sendTestEmail' ); } $resourcePath = '/emailCampaigns/{campaignId}/sendTest'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($emailTo)) { $_tempBody = $emailTo; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateCampaignStatus * * Update an email campaign status * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateCampaignStatus($campaignId, $status) { $this->updateCampaignStatusWithHttpInfo($campaignId, $status); } /** * Operation updateCampaignStatusWithHttpInfo * * Update an email campaign status * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateCampaignStatusWithHttpInfo($campaignId, $status) { $returnType = ''; $request = $this->updateCampaignStatusRequest($campaignId, $status); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateCampaignStatusAsync * * Update an email campaign status * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateCampaignStatusAsync($campaignId, $status) { return $this->updateCampaignStatusAsyncWithHttpInfo($campaignId, $status) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateCampaignStatusAsyncWithHttpInfo * * Update an email campaign status * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateCampaignStatusAsyncWithHttpInfo($campaignId, $status) { $returnType = ''; $request = $this->updateCampaignStatusRequest($campaignId, $status); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateCampaignStatus' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateCampaignStatusRequest($campaignId, $status) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling updateCampaignStatus' ); } // verify the required parameter 'status' is set if ($status === null || (is_array($status) && count($status) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $status when calling updateCampaignStatus' ); } $resourcePath = '/emailCampaigns/{campaignId}/status'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($status)) { $_tempBody = $status; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateEmailCampaign * * Update an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateEmailCampaign $emailCampaign Values to update a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateEmailCampaign($campaignId, $emailCampaign) { $this->updateEmailCampaignWithHttpInfo($campaignId, $emailCampaign); } /** * Operation updateEmailCampaignWithHttpInfo * * Update an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateEmailCampaign $emailCampaign Values to update a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateEmailCampaignWithHttpInfo($campaignId, $emailCampaign) { $returnType = ''; $request = $this->updateEmailCampaignRequest($campaignId, $emailCampaign); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateEmailCampaignAsync * * Update an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateEmailCampaign $emailCampaign Values to update a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateEmailCampaignAsync($campaignId, $emailCampaign) { return $this->updateEmailCampaignAsyncWithHttpInfo($campaignId, $emailCampaign) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateEmailCampaignAsyncWithHttpInfo * * Update an email campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateEmailCampaign $emailCampaign Values to update a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateEmailCampaignAsyncWithHttpInfo($campaignId, $emailCampaign) { $returnType = ''; $request = $this->updateEmailCampaignRequest($campaignId, $emailCampaign); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateEmailCampaign' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateEmailCampaign $emailCampaign Values to update a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateEmailCampaignRequest($campaignId, $emailCampaign) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling updateEmailCampaign' ); } // verify the required parameter 'emailCampaign' is set if ($emailCampaign === null || (is_array($emailCampaign) && count($emailCampaign) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $emailCampaign when calling updateEmailCampaign' ); } $resourcePath = '/emailCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($emailCampaign)) { $_tempBody = $emailCampaign; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation uploadImageToGallery * * Upload an image to your account's image gallery * * @param \Brevo\Client\Model\UploadImageToGallery $uploadImage Parameters to upload an image (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\UploadImageModel */ public function uploadImageToGallery($uploadImage) { list($response) = $this->uploadImageToGalleryWithHttpInfo($uploadImage); return $response; } /** * Operation uploadImageToGalleryWithHttpInfo * * Upload an image to your account's image gallery * * @param \Brevo\Client\Model\UploadImageToGallery $uploadImage Parameters to upload an image (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\UploadImageModel, HTTP status code, HTTP response headers (array of strings) */ public function uploadImageToGalleryWithHttpInfo($uploadImage) { $returnType = '\Brevo\Client\Model\UploadImageModel'; $request = $this->uploadImageToGalleryRequest($uploadImage); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\UploadImageModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation uploadImageToGalleryAsync * * Upload an image to your account's image gallery * * @param \Brevo\Client\Model\UploadImageToGallery $uploadImage Parameters to upload an image (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function uploadImageToGalleryAsync($uploadImage) { return $this->uploadImageToGalleryAsyncWithHttpInfo($uploadImage) ->then( function ($response) { return $response[0]; } ); } /** * Operation uploadImageToGalleryAsyncWithHttpInfo * * Upload an image to your account's image gallery * * @param \Brevo\Client\Model\UploadImageToGallery $uploadImage Parameters to upload an image (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function uploadImageToGalleryAsyncWithHttpInfo($uploadImage) { $returnType = '\Brevo\Client\Model\UploadImageModel'; $request = $this->uploadImageToGalleryRequest($uploadImage); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'uploadImageToGallery' * * @param \Brevo\Client\Model\UploadImageToGallery $uploadImage Parameters to upload an image (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function uploadImageToGalleryRequest($uploadImage) { // verify the required parameter 'uploadImage' is set if ($uploadImage === null || (is_array($uploadImage) && count($uploadImage) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uploadImage when calling uploadImageToGallery' ); } $resourcePath = '/emailCampaigns/images'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($uploadImage)) { $_tempBody = $uploadImage; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/NotesApi.php 0000644 00000153723 15021222673 0012173 0 ustar 00 <?php /** * NotesApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * NotesApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NotesApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation crmNotesGet * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\NoteList */ public function crmNotesGet($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { list($response) = $this->crmNotesGetWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $response; } /** * Operation crmNotesGetWithHttpInfo * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\NoteList, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesGetWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\NoteList'; $request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\NoteList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesGetAsync * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesGetAsync($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { return $this->crmNotesGetAsyncWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesGetAsyncWithHttpInfo * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesGetAsyncWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\NoteList'; $request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesGet' * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesGetRequest($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $resourcePath = '/crm/notes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($entity !== null) { $queryParams['entity'] = ObjectSerializer::toQueryValue($entity); } // query params if ($entityIds !== null) { $queryParams['entityIds'] = ObjectSerializer::toQueryValue($entityIds); } // query params if ($dateFrom !== null) { $queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom); } // query params if ($dateTo !== null) { $queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdDelete * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmNotesIdDelete($id) { $this->crmNotesIdDeleteWithHttpInfo($id); } /** * Operation crmNotesIdDeleteWithHttpInfo * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmNotesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdDeleteAsync * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdDeleteAsync($id) { return $this->crmNotesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdDeleteAsyncWithHttpInfo * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmNotesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdDelete' * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdDelete' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdGet * * Get a note * * @param string $id Note ID to get (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Note */ public function crmNotesIdGet($id) { list($response) = $this->crmNotesIdGetWithHttpInfo($id); return $response; } /** * Operation crmNotesIdGetWithHttpInfo * * Get a note * * @param string $id Note ID to get (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Note, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Note'; $request = $this->crmNotesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Note', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdGetAsync * * Get a note * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdGetAsync($id) { return $this->crmNotesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdGetAsyncWithHttpInfo * * Get a note * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Note'; $request = $this->crmNotesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdGet' * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdGet' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdPatch * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmNotesIdPatch($id, $body) { $this->crmNotesIdPatchWithHttpInfo($id, $body); } /** * Operation crmNotesIdPatchWithHttpInfo * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmNotesIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 415: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdPatchAsync * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdPatchAsync($id, $body) { return $this->crmNotesIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdPatchAsyncWithHttpInfo * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmNotesIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdPatch' * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmNotesIdPatch' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesPost * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\NoteId */ public function crmNotesPost($body) { list($response) = $this->crmNotesPostWithHttpInfo($body); return $response; } /** * Operation crmNotesPostWithHttpInfo * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\NoteId, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\NoteId'; $request = $this->crmNotesPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\NoteId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 415: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesPostAsync * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesPostAsync($body) { return $this->crmNotesPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesPostAsyncWithHttpInfo * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\NoteId'; $request = $this->crmNotesPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesPost' * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmNotesPost' ); } $resourcePath = '/crm/notes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/AttributesApi.php 0000644 00000125371 15021222673 0013227 0 ustar 00 <?php /** * AttributesApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * AttributesApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AttributesApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createAttribute * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createAttribute($attributeCategory, $attributeName, $createAttribute) { $this->createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute); } /** * Operation createAttributeWithHttpInfo * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute) { $returnType = ''; $request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createAttributeAsync * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createAttributeAsync($attributeCategory, $attributeName, $createAttribute) { return $this->createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute) ->then( function ($response) { return $response[0]; } ); } /** * Operation createAttributeAsyncWithHttpInfo * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute) { $returnType = ''; $request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createAttributeRequest($attributeCategory, $attributeName, $createAttribute) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling createAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling createAttribute' ); } // verify the required parameter 'createAttribute' is set if ($createAttribute === null || (is_array($createAttribute) && count($createAttribute) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createAttribute when calling createAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if (isset($createAttribute)) { $_tempBody = $createAttribute; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteAttribute * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteAttribute($attributeCategory, $attributeName) { $this->deleteAttributeWithHttpInfo($attributeCategory, $attributeName); } /** * Operation deleteAttributeWithHttpInfo * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteAttributeWithHttpInfo($attributeCategory, $attributeName) { $returnType = ''; $request = $this->deleteAttributeRequest($attributeCategory, $attributeName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteAttributeAsync * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteAttributeAsync($attributeCategory, $attributeName) { return $this->deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteAttributeAsyncWithHttpInfo * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName) { $returnType = ''; $request = $this->deleteAttributeRequest($attributeCategory, $attributeName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteAttributeRequest($attributeCategory, $attributeName) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling deleteAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling deleteAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAttributes * * List all attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAttributes */ public function getAttributes() { list($response) = $this->getAttributesWithHttpInfo(); return $response; } /** * Operation getAttributesWithHttpInfo * * List all attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAttributes, HTTP status code, HTTP response headers (array of strings) */ public function getAttributesWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAttributes'; $request = $this->getAttributesRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAttributes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAttributesAsync * * List all attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAttributesAsync() { return $this->getAttributesAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getAttributesAsyncWithHttpInfo * * List all attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAttributesAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAttributes'; $request = $this->getAttributesRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAttributes' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAttributesRequest() { $resourcePath = '/contacts/attributes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateAttribute * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateAttribute($attributeCategory, $attributeName, $updateAttribute) { $this->updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute); } /** * Operation updateAttributeWithHttpInfo * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) { $returnType = ''; $request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateAttributeAsync * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateAttributeAsync($attributeCategory, $attributeName, $updateAttribute) { return $this->updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateAttributeAsyncWithHttpInfo * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) { $returnType = ''; $request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling updateAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling updateAttribute' ); } // verify the required parameter 'updateAttribute' is set if ($updateAttribute === null || (is_array($updateAttribute) && count($updateAttribute) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateAttribute when calling updateAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if (isset($updateAttribute)) { $_tempBody = $updateAttribute; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/TransactionalSMSApi.php 0000644 00000156352 15021222673 0014271 0 ustar 00 <?php /** * TransactionalSMSApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * TransactionalSMSApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalSMSApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getSmsEvents * * Get all your SMS activity (unaggregated events) * * @param int $limit Number of documents per page (optional, default to 50) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $offset Index of the first document of the page (optional, default to 0) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $phoneNumber Filter the report for a specific phone number (optional) * @param string $event Filter the report for specific events (optional) * @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSmsEventReport */ public function getSmsEvents($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null, $sort = 'desc') { list($response) = $this->getSmsEventsWithHttpInfo($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort); return $response; } /** * Operation getSmsEventsWithHttpInfo * * Get all your SMS activity (unaggregated events) * * @param int $limit Number of documents per page (optional, default to 50) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $offset Index of the first document of the page (optional, default to 0) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $phoneNumber Filter the report for a specific phone number (optional) * @param string $event Filter the report for specific events (optional) * @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSmsEventReport, HTTP status code, HTTP response headers (array of strings) */ public function getSmsEventsWithHttpInfo($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmsEventReport'; $request = $this->getSmsEventsRequest($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSmsEventReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmsEventsAsync * * Get all your SMS activity (unaggregated events) * * @param int $limit Number of documents per page (optional, default to 50) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $offset Index of the first document of the page (optional, default to 0) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $phoneNumber Filter the report for a specific phone number (optional) * @param string $event Filter the report for specific events (optional) * @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsEventsAsync($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null, $sort = 'desc') { return $this->getSmsEventsAsyncWithHttpInfo($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmsEventsAsyncWithHttpInfo * * Get all your SMS activity (unaggregated events) * * @param int $limit Number of documents per page (optional, default to 50) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $offset Index of the first document of the page (optional, default to 0) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $phoneNumber Filter the report for a specific phone number (optional) * @param string $event Filter the report for specific events (optional) * @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsEventsAsyncWithHttpInfo($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmsEventReport'; $request = $this->getSmsEventsRequest($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmsEvents' * * @param int $limit Number of documents per page (optional, default to 50) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $offset Index of the first document of the page (optional, default to 0) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $phoneNumber Filter the report for a specific phone number (optional) * @param string $event Filter the report for specific events (optional) * @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmsEventsRequest($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null, $sort = 'desc') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalSMSApi.getSmsEvents, must be smaller than or equal to 100.'); } $resourcePath = '/transactionalSMS/statistics/events'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($phoneNumber !== null) { $queryParams['phoneNumber'] = ObjectSerializer::toQueryValue($phoneNumber); } // query params if ($event !== null) { $queryParams['event'] = ObjectSerializer::toQueryValue($event); } // query params if ($tags !== null) { $queryParams['tags'] = ObjectSerializer::toQueryValue($tags); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getTransacAggregatedSmsReport * * Get your SMS activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) * @param string $tag Filter on a tag (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetTransacAggregatedSmsReport */ public function getTransacAggregatedSmsReport($startDate = null, $endDate = null, $days = null, $tag = null) { list($response) = $this->getTransacAggregatedSmsReportWithHttpInfo($startDate, $endDate, $days, $tag); return $response; } /** * Operation getTransacAggregatedSmsReportWithHttpInfo * * Get your SMS activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) * @param string $tag Filter on a tag (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetTransacAggregatedSmsReport, HTTP status code, HTTP response headers (array of strings) */ public function getTransacAggregatedSmsReportWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null) { $returnType = '\Brevo\Client\Model\GetTransacAggregatedSmsReport'; $request = $this->getTransacAggregatedSmsReportRequest($startDate, $endDate, $days, $tag); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetTransacAggregatedSmsReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getTransacAggregatedSmsReportAsync * * Get your SMS activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) * @param string $tag Filter on a tag (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacAggregatedSmsReportAsync($startDate = null, $endDate = null, $days = null, $tag = null) { return $this->getTransacAggregatedSmsReportAsyncWithHttpInfo($startDate, $endDate, $days, $tag) ->then( function ($response) { return $response[0]; } ); } /** * Operation getTransacAggregatedSmsReportAsyncWithHttpInfo * * Get your SMS activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) * @param string $tag Filter on a tag (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacAggregatedSmsReportAsyncWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null) { $returnType = '\Brevo\Client\Model\GetTransacAggregatedSmsReport'; $request = $this->getTransacAggregatedSmsReportRequest($startDate, $endDate, $days, $tag); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getTransacAggregatedSmsReport' * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional) * @param string $tag Filter on a tag (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getTransacAggregatedSmsReportRequest($startDate = null, $endDate = null, $days = null, $tag = null) { $resourcePath = '/transactionalSMS/statistics/aggregatedReport'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($tag !== null) { $queryParams['tag'] = ObjectSerializer::toQueryValue($tag); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getTransacSmsReport * * Get your SMS activity aggregated per day * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Filter on a tag (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetTransacSmsReport */ public function getTransacSmsReport($startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { list($response) = $this->getTransacSmsReportWithHttpInfo($startDate, $endDate, $days, $tag, $sort); return $response; } /** * Operation getTransacSmsReportWithHttpInfo * * Get your SMS activity aggregated per day * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Filter on a tag (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetTransacSmsReport, HTTP status code, HTTP response headers (array of strings) */ public function getTransacSmsReportWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetTransacSmsReport'; $request = $this->getTransacSmsReportRequest($startDate, $endDate, $days, $tag, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetTransacSmsReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getTransacSmsReportAsync * * Get your SMS activity aggregated per day * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Filter on a tag (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacSmsReportAsync($startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { return $this->getTransacSmsReportAsyncWithHttpInfo($startDate, $endDate, $days, $tag, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getTransacSmsReportAsyncWithHttpInfo * * Get your SMS activity aggregated per day * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Filter on a tag (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacSmsReportAsyncWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetTransacSmsReport'; $request = $this->getTransacSmsReportRequest($startDate, $endDate, $days, $tag, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getTransacSmsReport' * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Filter on a tag (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getTransacSmsReportRequest($startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { $resourcePath = '/transactionalSMS/statistics/reports'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($tag !== null) { $queryParams['tag'] = ObjectSerializer::toQueryValue($tag); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendTransacSms * * Send SMS message to a mobile number * * @param \Brevo\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\SendSms */ public function sendTransacSms($sendTransacSms) { list($response) = $this->sendTransacSmsWithHttpInfo($sendTransacSms); return $response; } /** * Operation sendTransacSmsWithHttpInfo * * Send SMS message to a mobile number * * @param \Brevo\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\SendSms, HTTP status code, HTTP response headers (array of strings) */ public function sendTransacSmsWithHttpInfo($sendTransacSms) { $returnType = '\Brevo\Client\Model\SendSms'; $request = $this->sendTransacSmsRequest($sendTransacSms); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\SendSms', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 402: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendTransacSmsAsync * * Send SMS message to a mobile number * * @param \Brevo\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTransacSmsAsync($sendTransacSms) { return $this->sendTransacSmsAsyncWithHttpInfo($sendTransacSms) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendTransacSmsAsyncWithHttpInfo * * Send SMS message to a mobile number * * @param \Brevo\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTransacSmsAsyncWithHttpInfo($sendTransacSms) { $returnType = '\Brevo\Client\Model\SendSms'; $request = $this->sendTransacSmsRequest($sendTransacSms); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendTransacSms' * * @param \Brevo\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendTransacSmsRequest($sendTransacSms) { // verify the required parameter 'sendTransacSms' is set if ($sendTransacSms === null || (is_array($sendTransacSms) && count($sendTransacSms) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendTransacSms when calling sendTransacSms' ); } $resourcePath = '/transactionalSMS/sms'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($sendTransacSms)) { $_tempBody = $sendTransacSms; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/TransactionalEmailsApi.php 0000644 00000767461 15021222673 0015052 0 ustar 00 <?php /** * TransactionalEmailsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * TransactionalEmailsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalEmailsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation blockNewDomain * * Add a new domain to the list of blocked domains * * @param \Brevo\Client\Model\BlockDomain $blockDomain blockDomain (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function blockNewDomain($blockDomain) { $this->blockNewDomainWithHttpInfo($blockDomain); } /** * Operation blockNewDomainWithHttpInfo * * Add a new domain to the list of blocked domains * * @param \Brevo\Client\Model\BlockDomain $blockDomain (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function blockNewDomainWithHttpInfo($blockDomain) { $returnType = ''; $request = $this->blockNewDomainRequest($blockDomain); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation blockNewDomainAsync * * Add a new domain to the list of blocked domains * * @param \Brevo\Client\Model\BlockDomain $blockDomain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function blockNewDomainAsync($blockDomain) { return $this->blockNewDomainAsyncWithHttpInfo($blockDomain) ->then( function ($response) { return $response[0]; } ); } /** * Operation blockNewDomainAsyncWithHttpInfo * * Add a new domain to the list of blocked domains * * @param \Brevo\Client\Model\BlockDomain $blockDomain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function blockNewDomainAsyncWithHttpInfo($blockDomain) { $returnType = ''; $request = $this->blockNewDomainRequest($blockDomain); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'blockNewDomain' * * @param \Brevo\Client\Model\BlockDomain $blockDomain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function blockNewDomainRequest($blockDomain) { // verify the required parameter 'blockDomain' is set if ($blockDomain === null || (is_array($blockDomain) && count($blockDomain) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $blockDomain when calling blockNewDomain' ); } $resourcePath = '/smtp/blockedDomains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($blockDomain)) { $_tempBody = $blockDomain; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createSmtpTemplate * * Create an email template * * @param \Brevo\Client\Model\CreateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createSmtpTemplate($smtpTemplate) { list($response) = $this->createSmtpTemplateWithHttpInfo($smtpTemplate); return $response; } /** * Operation createSmtpTemplateWithHttpInfo * * Create an email template * * @param \Brevo\Client\Model\CreateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createSmtpTemplateWithHttpInfo($smtpTemplate) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createSmtpTemplateRequest($smtpTemplate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createSmtpTemplateAsync * * Create an email template * * @param \Brevo\Client\Model\CreateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSmtpTemplateAsync($smtpTemplate) { return $this->createSmtpTemplateAsyncWithHttpInfo($smtpTemplate) ->then( function ($response) { return $response[0]; } ); } /** * Operation createSmtpTemplateAsyncWithHttpInfo * * Create an email template * * @param \Brevo\Client\Model\CreateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSmtpTemplateAsyncWithHttpInfo($smtpTemplate) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createSmtpTemplateRequest($smtpTemplate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createSmtpTemplate' * * @param \Brevo\Client\Model\CreateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createSmtpTemplateRequest($smtpTemplate) { // verify the required parameter 'smtpTemplate' is set if ($smtpTemplate === null || (is_array($smtpTemplate) && count($smtpTemplate) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $smtpTemplate when calling createSmtpTemplate' ); } $resourcePath = '/smtp/templates'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($smtpTemplate)) { $_tempBody = $smtpTemplate; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteBlockedDomain * * Unblock an existing domain from the list of blocked domains * * @param string $domain The name of the domain to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteBlockedDomain($domain) { $this->deleteBlockedDomainWithHttpInfo($domain); } /** * Operation deleteBlockedDomainWithHttpInfo * * Unblock an existing domain from the list of blocked domains * * @param string $domain The name of the domain to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteBlockedDomainWithHttpInfo($domain) { $returnType = ''; $request = $this->deleteBlockedDomainRequest($domain); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteBlockedDomainAsync * * Unblock an existing domain from the list of blocked domains * * @param string $domain The name of the domain to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteBlockedDomainAsync($domain) { return $this->deleteBlockedDomainAsyncWithHttpInfo($domain) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteBlockedDomainAsyncWithHttpInfo * * Unblock an existing domain from the list of blocked domains * * @param string $domain The name of the domain to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteBlockedDomainAsyncWithHttpInfo($domain) { $returnType = ''; $request = $this->deleteBlockedDomainRequest($domain); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteBlockedDomain' * * @param string $domain The name of the domain to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteBlockedDomainRequest($domain) { // verify the required parameter 'domain' is set if ($domain === null || (is_array($domain) && count($domain) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domain when calling deleteBlockedDomain' ); } $resourcePath = '/smtp/blockedDomains/{domain}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($domain !== null) { $resourcePath = str_replace( '{' . 'domain' . '}', ObjectSerializer::toPathValue($domain), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteHardbounces * * Delete hardbounces * * @param \Brevo\Client\Model\DeleteHardbounces $deleteHardbounces values to delete hardbounces (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteHardbounces($deleteHardbounces = null) { $this->deleteHardbouncesWithHttpInfo($deleteHardbounces); } /** * Operation deleteHardbouncesWithHttpInfo * * Delete hardbounces * * @param \Brevo\Client\Model\DeleteHardbounces $deleteHardbounces values to delete hardbounces (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteHardbouncesWithHttpInfo($deleteHardbounces = null) { $returnType = ''; $request = $this->deleteHardbouncesRequest($deleteHardbounces); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteHardbouncesAsync * * Delete hardbounces * * @param \Brevo\Client\Model\DeleteHardbounces $deleteHardbounces values to delete hardbounces (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteHardbouncesAsync($deleteHardbounces = null) { return $this->deleteHardbouncesAsyncWithHttpInfo($deleteHardbounces) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteHardbouncesAsyncWithHttpInfo * * Delete hardbounces * * @param \Brevo\Client\Model\DeleteHardbounces $deleteHardbounces values to delete hardbounces (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteHardbouncesAsyncWithHttpInfo($deleteHardbounces = null) { $returnType = ''; $request = $this->deleteHardbouncesRequest($deleteHardbounces); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteHardbounces' * * @param \Brevo\Client\Model\DeleteHardbounces $deleteHardbounces values to delete hardbounces (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteHardbouncesRequest($deleteHardbounces = null) { $resourcePath = '/smtp/deleteHardbounces'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($deleteHardbounces)) { $_tempBody = $deleteHardbounces; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteScheduledEmailById * * Delete scheduled emails by batchId or messageId * * @param string $identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteScheduledEmailById($identifier) { $this->deleteScheduledEmailByIdWithHttpInfo($identifier); } /** * Operation deleteScheduledEmailByIdWithHttpInfo * * Delete scheduled emails by batchId or messageId * * @param string $identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteScheduledEmailByIdWithHttpInfo($identifier) { $returnType = ''; $request = $this->deleteScheduledEmailByIdRequest($identifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteScheduledEmailByIdAsync * * Delete scheduled emails by batchId or messageId * * @param string $identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteScheduledEmailByIdAsync($identifier) { return $this->deleteScheduledEmailByIdAsyncWithHttpInfo($identifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteScheduledEmailByIdAsyncWithHttpInfo * * Delete scheduled emails by batchId or messageId * * @param string $identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteScheduledEmailByIdAsyncWithHttpInfo($identifier) { $returnType = ''; $request = $this->deleteScheduledEmailByIdRequest($identifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteScheduledEmailById' * * @param string $identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteScheduledEmailByIdRequest($identifier) { // verify the required parameter 'identifier' is set if ($identifier === null || (is_array($identifier) && count($identifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $identifier when calling deleteScheduledEmailById' ); } $resourcePath = '/smtp/email/{identifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($identifier !== null) { $resourcePath = str_replace( '{' . 'identifier' . '}', ObjectSerializer::toPathValue($identifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteSmtpTemplate * * Delete an inactive email template * * @param int $templateId id of the template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteSmtpTemplate($templateId) { $this->deleteSmtpTemplateWithHttpInfo($templateId); } /** * Operation deleteSmtpTemplateWithHttpInfo * * Delete an inactive email template * * @param int $templateId id of the template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteSmtpTemplateWithHttpInfo($templateId) { $returnType = ''; $request = $this->deleteSmtpTemplateRequest($templateId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteSmtpTemplateAsync * * Delete an inactive email template * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSmtpTemplateAsync($templateId) { return $this->deleteSmtpTemplateAsyncWithHttpInfo($templateId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteSmtpTemplateAsyncWithHttpInfo * * Delete an inactive email template * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSmtpTemplateAsyncWithHttpInfo($templateId) { $returnType = ''; $request = $this->deleteSmtpTemplateRequest($templateId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteSmtpTemplate' * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteSmtpTemplateRequest($templateId) { // verify the required parameter 'templateId' is set if ($templateId === null || (is_array($templateId) && count($templateId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $templateId when calling deleteSmtpTemplate' ); } $resourcePath = '/smtp/templates/{templateId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($templateId !== null) { $resourcePath = str_replace( '{' . 'templateId' . '}', ObjectSerializer::toPathValue($templateId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAggregatedSmtpReport * * Get your transactional email activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAggregatedReport */ public function getAggregatedSmtpReport($startDate = null, $endDate = null, $days = null, $tag = null) { list($response) = $this->getAggregatedSmtpReportWithHttpInfo($startDate, $endDate, $days, $tag); return $response; } /** * Operation getAggregatedSmtpReportWithHttpInfo * * Get your transactional email activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAggregatedReport, HTTP status code, HTTP response headers (array of strings) */ public function getAggregatedSmtpReportWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null) { $returnType = '\Brevo\Client\Model\GetAggregatedReport'; $request = $this->getAggregatedSmtpReportRequest($startDate, $endDate, $days, $tag); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAggregatedReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAggregatedSmtpReportAsync * * Get your transactional email activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAggregatedSmtpReportAsync($startDate = null, $endDate = null, $days = null, $tag = null) { return $this->getAggregatedSmtpReportAsyncWithHttpInfo($startDate, $endDate, $days, $tag) ->then( function ($response) { return $response[0]; } ); } /** * Operation getAggregatedSmtpReportAsyncWithHttpInfo * * Get your transactional email activity aggregated over a period of time * * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAggregatedSmtpReportAsyncWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null) { $returnType = '\Brevo\Client\Model\GetAggregatedReport'; $request = $this->getAggregatedSmtpReportRequest($startDate, $endDate, $days, $tag); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAggregatedSmtpReport' * * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAggregatedSmtpReportRequest($startDate = null, $endDate = null, $days = null, $tag = null) { $resourcePath = '/smtp/statistics/aggregatedReport'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($tag !== null) { $queryParams['tag'] = ObjectSerializer::toQueryValue($tag); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getBlockedDomains * * Get the list of blocked domains * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetBlockedDomains */ public function getBlockedDomains() { list($response) = $this->getBlockedDomainsWithHttpInfo(); return $response; } /** * Operation getBlockedDomainsWithHttpInfo * * Get the list of blocked domains * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetBlockedDomains, HTTP status code, HTTP response headers (array of strings) */ public function getBlockedDomainsWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetBlockedDomains'; $request = $this->getBlockedDomainsRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetBlockedDomains', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getBlockedDomainsAsync * * Get the list of blocked domains * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getBlockedDomainsAsync() { return $this->getBlockedDomainsAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getBlockedDomainsAsyncWithHttpInfo * * Get the list of blocked domains * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getBlockedDomainsAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetBlockedDomains'; $request = $this->getBlockedDomainsRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getBlockedDomains' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getBlockedDomainsRequest() { $resourcePath = '/smtp/blockedDomains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getEmailEventReport * * Get all your transactional email activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $email Filter the report for a specific email addresses (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $tags Filter the report for tags (serialized and urlencoded array) (optional) * @param string $messageId Filter on a specific message id (optional) * @param int $templateId Filter on a specific template id (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetEmailEventReport */ public function getEmailEventReport($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $email = null, $event = null, $tags = null, $messageId = null, $templateId = null, $sort = 'desc') { list($response) = $this->getEmailEventReportWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort); return $response; } /** * Operation getEmailEventReportWithHttpInfo * * Get all your transactional email activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $email Filter the report for a specific email addresses (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $tags Filter the report for tags (serialized and urlencoded array) (optional) * @param string $messageId Filter on a specific message id (optional) * @param int $templateId Filter on a specific template id (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetEmailEventReport, HTTP status code, HTTP response headers (array of strings) */ public function getEmailEventReportWithHttpInfo($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $email = null, $event = null, $tags = null, $messageId = null, $templateId = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetEmailEventReport'; $request = $this->getEmailEventReportRequest($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetEmailEventReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getEmailEventReportAsync * * Get all your transactional email activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $email Filter the report for a specific email addresses (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $tags Filter the report for tags (serialized and urlencoded array) (optional) * @param string $messageId Filter on a specific message id (optional) * @param int $templateId Filter on a specific template id (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailEventReportAsync($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $email = null, $event = null, $tags = null, $messageId = null, $templateId = null, $sort = 'desc') { return $this->getEmailEventReportAsyncWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getEmailEventReportAsyncWithHttpInfo * * Get all your transactional email activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $email Filter the report for a specific email addresses (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $tags Filter the report for tags (serialized and urlencoded array) (optional) * @param string $messageId Filter on a specific message id (optional) * @param int $templateId Filter on a specific template id (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getEmailEventReportAsyncWithHttpInfo($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $email = null, $event = null, $tags = null, $messageId = null, $templateId = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetEmailEventReport'; $request = $this->getEmailEventReportRequest($limit, $offset, $startDate, $endDate, $days, $email, $event, $tags, $messageId, $templateId, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getEmailEventReport' * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $email Filter the report for a specific email addresses (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $tags Filter the report for tags (serialized and urlencoded array) (optional) * @param string $messageId Filter on a specific message id (optional) * @param int $templateId Filter on a specific template id (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getEmailEventReportRequest($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $email = null, $event = null, $tags = null, $messageId = null, $templateId = null, $sort = 'desc') { if ($limit !== null && $limit > 5000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getEmailEventReport, must be smaller than or equal to 5000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getEmailEventReport, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/statistics/events'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($email !== null) { $queryParams['email'] = ObjectSerializer::toQueryValue($email); } // query params if ($event !== null) { $queryParams['event'] = ObjectSerializer::toQueryValue($event); } // query params if ($tags !== null) { $queryParams['tags'] = ObjectSerializer::toQueryValue($tags); } // query params if ($messageId !== null) { $queryParams['messageId'] = ObjectSerializer::toQueryValue($messageId); } // query params if ($templateId !== null) { $queryParams['templateId'] = ObjectSerializer::toQueryValue($templateId); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getScheduledEmailByBatchId * * Fetch scheduled emails by batchId * * @param string $batchId The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string $status Filter the records by `status` of the scheduled email batch or message. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetScheduledEmailByBatchId */ public function getScheduledEmailByBatchId($batchId, $startDate = null, $endDate = null, $sort = 'desc', $status = null, $limit = '100', $offset = '0') { list($response) = $this->getScheduledEmailByBatchIdWithHttpInfo($batchId, $startDate, $endDate, $sort, $status, $limit, $offset); return $response; } /** * Operation getScheduledEmailByBatchIdWithHttpInfo * * Fetch scheduled emails by batchId * * @param string $batchId The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string $status Filter the records by `status` of the scheduled email batch or message. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetScheduledEmailByBatchId, HTTP status code, HTTP response headers (array of strings) */ public function getScheduledEmailByBatchIdWithHttpInfo($batchId, $startDate = null, $endDate = null, $sort = 'desc', $status = null, $limit = '100', $offset = '0') { $returnType = '\Brevo\Client\Model\GetScheduledEmailByBatchId'; $request = $this->getScheduledEmailByBatchIdRequest($batchId, $startDate, $endDate, $sort, $status, $limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetScheduledEmailByBatchId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getScheduledEmailByBatchIdAsync * * Fetch scheduled emails by batchId * * @param string $batchId The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string $status Filter the records by `status` of the scheduled email batch or message. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getScheduledEmailByBatchIdAsync($batchId, $startDate = null, $endDate = null, $sort = 'desc', $status = null, $limit = '100', $offset = '0') { return $this->getScheduledEmailByBatchIdAsyncWithHttpInfo($batchId, $startDate, $endDate, $sort, $status, $limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getScheduledEmailByBatchIdAsyncWithHttpInfo * * Fetch scheduled emails by batchId * * @param string $batchId The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string $status Filter the records by `status` of the scheduled email batch or message. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getScheduledEmailByBatchIdAsyncWithHttpInfo($batchId, $startDate = null, $endDate = null, $sort = 'desc', $status = null, $limit = '100', $offset = '0') { $returnType = '\Brevo\Client\Model\GetScheduledEmailByBatchId'; $request = $this->getScheduledEmailByBatchIdRequest($batchId, $startDate, $endDate, $sort, $status, $limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getScheduledEmailByBatchId' * * @param string $batchId The batchId of scheduled emails batch (Should be a valid UUIDv4) (required) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string $status Filter the records by `status` of the scheduled email batch or message. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getScheduledEmailByBatchIdRequest($batchId, $startDate = null, $endDate = null, $sort = 'desc', $status = null, $limit = '100', $offset = '0') { // verify the required parameter 'batchId' is set if ($batchId === null || (is_array($batchId) && count($batchId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $batchId when calling getScheduledEmailByBatchId' ); } if ($limit !== null && $limit > 500) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getScheduledEmailByBatchId, must be smaller than or equal to 500.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getScheduledEmailByBatchId, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/emailStatus/{batchId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($status !== null) { $queryParams['status'] = ObjectSerializer::toQueryValue($status); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // path params if ($batchId !== null) { $resourcePath = str_replace( '{' . 'batchId' . '}', ObjectSerializer::toPathValue($batchId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getScheduledEmailByMessageId * * Fetch scheduled email by messageId * * @param string $messageId The messageId of scheduled email (required) * @param \DateTime $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetScheduledEmailByMessageId */ public function getScheduledEmailByMessageId($messageId, $startDate = null, $endDate = null) { list($response) = $this->getScheduledEmailByMessageIdWithHttpInfo($messageId, $startDate, $endDate); return $response; } /** * Operation getScheduledEmailByMessageIdWithHttpInfo * * Fetch scheduled email by messageId * * @param string $messageId The messageId of scheduled email (required) * @param \DateTime $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetScheduledEmailByMessageId, HTTP status code, HTTP response headers (array of strings) */ public function getScheduledEmailByMessageIdWithHttpInfo($messageId, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetScheduledEmailByMessageId'; $request = $this->getScheduledEmailByMessageIdRequest($messageId, $startDate, $endDate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetScheduledEmailByMessageId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getScheduledEmailByMessageIdAsync * * Fetch scheduled email by messageId * * @param string $messageId The messageId of scheduled email (required) * @param \DateTime $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getScheduledEmailByMessageIdAsync($messageId, $startDate = null, $endDate = null) { return $this->getScheduledEmailByMessageIdAsyncWithHttpInfo($messageId, $startDate, $endDate) ->then( function ($response) { return $response[0]; } ); } /** * Operation getScheduledEmailByMessageIdAsyncWithHttpInfo * * Fetch scheduled email by messageId * * @param string $messageId The messageId of scheduled email (required) * @param \DateTime $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getScheduledEmailByMessageIdAsyncWithHttpInfo($messageId, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetScheduledEmailByMessageId'; $request = $this->getScheduledEmailByMessageIdRequest($messageId, $startDate, $endDate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getScheduledEmailByMessageId' * * @param string $messageId The messageId of scheduled email (required) * @param \DateTime $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. (optional) * @param \DateTime $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getScheduledEmailByMessageIdRequest($messageId, $startDate = null, $endDate = null) { // verify the required parameter 'messageId' is set if ($messageId === null || (is_array($messageId) && count($messageId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $messageId when calling getScheduledEmailByMessageId' ); } $resourcePath = '/smtp/emailStatus/{messageId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // path params if ($messageId !== null) { $resourcePath = str_replace( '{' . 'messageId' . '}', ObjectSerializer::toPathValue($messageId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSmtpReport * * Get your transactional email activity aggregated per day * * @param int $limit Number of documents returned per page (optional, default to 10) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetReports */ public function getSmtpReport($limit = '10', $offset = '0', $startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { list($response) = $this->getSmtpReportWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $tag, $sort); return $response; } /** * Operation getSmtpReportWithHttpInfo * * Get your transactional email activity aggregated per day * * @param int $limit Number of documents returned per page (optional, default to 10) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetReports, HTTP status code, HTTP response headers (array of strings) */ public function getSmtpReportWithHttpInfo($limit = '10', $offset = '0', $startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetReports'; $request = $this->getSmtpReportRequest($limit, $offset, $startDate, $endDate, $days, $tag, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetReports', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmtpReportAsync * * Get your transactional email activity aggregated per day * * @param int $limit Number of documents returned per page (optional, default to 10) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpReportAsync($limit = '10', $offset = '0', $startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { return $this->getSmtpReportAsyncWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $tag, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmtpReportAsyncWithHttpInfo * * Get your transactional email activity aggregated per day * * @param int $limit Number of documents returned per page (optional, default to 10) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpReportAsyncWithHttpInfo($limit = '10', $offset = '0', $startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetReports'; $request = $this->getSmtpReportRequest($limit, $offset, $startDate, $endDate, $days, $tag, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmtpReport' * * @param int $limit Number of documents returned per page (optional, default to 10) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional) * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) * @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) * @param string $tag Tag of the emails (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmtpReportRequest($limit = '10', $offset = '0', $startDate = null, $endDate = null, $days = null, $tag = null, $sort = 'desc') { if ($limit !== null && $limit > 30) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getSmtpReport, must be smaller than or equal to 30.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getSmtpReport, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/statistics/reports'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($tag !== null) { $queryParams['tag'] = ObjectSerializer::toQueryValue($tag); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSmtpTemplate * * Returns the template information * * @param int $templateId id of the template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSmtpTemplateOverview */ public function getSmtpTemplate($templateId) { list($response) = $this->getSmtpTemplateWithHttpInfo($templateId); return $response; } /** * Operation getSmtpTemplateWithHttpInfo * * Returns the template information * * @param int $templateId id of the template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSmtpTemplateOverview, HTTP status code, HTTP response headers (array of strings) */ public function getSmtpTemplateWithHttpInfo($templateId) { $returnType = '\Brevo\Client\Model\GetSmtpTemplateOverview'; $request = $this->getSmtpTemplateRequest($templateId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSmtpTemplateOverview', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmtpTemplateAsync * * Returns the template information * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpTemplateAsync($templateId) { return $this->getSmtpTemplateAsyncWithHttpInfo($templateId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmtpTemplateAsyncWithHttpInfo * * Returns the template information * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpTemplateAsyncWithHttpInfo($templateId) { $returnType = '\Brevo\Client\Model\GetSmtpTemplateOverview'; $request = $this->getSmtpTemplateRequest($templateId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmtpTemplate' * * @param int $templateId id of the template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmtpTemplateRequest($templateId) { // verify the required parameter 'templateId' is set if ($templateId === null || (is_array($templateId) && count($templateId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $templateId when calling getSmtpTemplate' ); } $resourcePath = '/smtp/templates/{templateId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($templateId !== null) { $resourcePath = str_replace( '{' . 'templateId' . '}', ObjectSerializer::toPathValue($templateId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSmtpTemplates * * Get the list of email templates * * @param string $templateStatus Filter on the status of the template. Active = true, inactive = false (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSmtpTemplates */ public function getSmtpTemplates($templateStatus = null, $limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getSmtpTemplatesWithHttpInfo($templateStatus, $limit, $offset, $sort); return $response; } /** * Operation getSmtpTemplatesWithHttpInfo * * Get the list of email templates * * @param string $templateStatus Filter on the status of the template. Active = true, inactive = false (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSmtpTemplates, HTTP status code, HTTP response headers (array of strings) */ public function getSmtpTemplatesWithHttpInfo($templateStatus = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmtpTemplates'; $request = $this->getSmtpTemplatesRequest($templateStatus, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSmtpTemplates', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmtpTemplatesAsync * * Get the list of email templates * * @param string $templateStatus Filter on the status of the template. Active = true, inactive = false (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpTemplatesAsync($templateStatus = null, $limit = '50', $offset = '0', $sort = 'desc') { return $this->getSmtpTemplatesAsyncWithHttpInfo($templateStatus, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmtpTemplatesAsyncWithHttpInfo * * Get the list of email templates * * @param string $templateStatus Filter on the status of the template. Active = true, inactive = false (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmtpTemplatesAsyncWithHttpInfo($templateStatus = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmtpTemplates'; $request = $this->getSmtpTemplatesRequest($templateStatus, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmtpTemplates' * * @param string $templateStatus Filter on the status of the template. Active = true, inactive = false (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmtpTemplatesRequest($templateStatus = null, $limit = '50', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 1000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getSmtpTemplates, must be smaller than or equal to 1000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getSmtpTemplates, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/templates'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($templateStatus !== null) { $queryParams['templateStatus'] = ObjectSerializer::toQueryValue($templateStatus); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getTransacBlockedContacts * * Get the list of blocked or unsubscribed transactional contacts * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string[] $senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetTransacBlockedContacts */ public function getTransacBlockedContacts($startDate = null, $endDate = null, $limit = '50', $offset = '0', $senders = null, $sort = 'desc') { list($response) = $this->getTransacBlockedContactsWithHttpInfo($startDate, $endDate, $limit, $offset, $senders, $sort); return $response; } /** * Operation getTransacBlockedContactsWithHttpInfo * * Get the list of blocked or unsubscribed transactional contacts * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string[] $senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetTransacBlockedContacts, HTTP status code, HTTP response headers (array of strings) */ public function getTransacBlockedContactsWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $senders = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetTransacBlockedContacts'; $request = $this->getTransacBlockedContactsRequest($startDate, $endDate, $limit, $offset, $senders, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetTransacBlockedContacts', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getTransacBlockedContactsAsync * * Get the list of blocked or unsubscribed transactional contacts * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string[] $senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacBlockedContactsAsync($startDate = null, $endDate = null, $limit = '50', $offset = '0', $senders = null, $sort = 'desc') { return $this->getTransacBlockedContactsAsyncWithHttpInfo($startDate, $endDate, $limit, $offset, $senders, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getTransacBlockedContactsAsyncWithHttpInfo * * Get the list of blocked or unsubscribed transactional contacts * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string[] $senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacBlockedContactsAsyncWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $senders = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetTransacBlockedContacts'; $request = $this->getTransacBlockedContactsRequest($startDate, $endDate, $limit, $offset, $senders, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getTransacBlockedContacts' * * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional) * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string[] $senders Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getTransacBlockedContactsRequest($startDate = null, $endDate = null, $limit = '50', $offset = '0', $senders = null, $sort = 'desc') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getTransacBlockedContacts, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getTransacBlockedContacts, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/blockedContacts'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if (is_array($senders)) { $queryParams['senders'] = $senders; } else if ($senders !== null) { $queryParams['senders'] = ObjectSerializer::toQueryValue($senders); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getTransacEmailContent * * Get the personalized content of a sent transactional email * * @param string $uuid Unique id of the transactional email that has been sent to a particular contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetTransacEmailContent */ public function getTransacEmailContent($uuid) { list($response) = $this->getTransacEmailContentWithHttpInfo($uuid); return $response; } /** * Operation getTransacEmailContentWithHttpInfo * * Get the personalized content of a sent transactional email * * @param string $uuid Unique id of the transactional email that has been sent to a particular contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetTransacEmailContent, HTTP status code, HTTP response headers (array of strings) */ public function getTransacEmailContentWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetTransacEmailContent'; $request = $this->getTransacEmailContentRequest($uuid); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetTransacEmailContent', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getTransacEmailContentAsync * * Get the personalized content of a sent transactional email * * @param string $uuid Unique id of the transactional email that has been sent to a particular contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacEmailContentAsync($uuid) { return $this->getTransacEmailContentAsyncWithHttpInfo($uuid) ->then( function ($response) { return $response[0]; } ); } /** * Operation getTransacEmailContentAsyncWithHttpInfo * * Get the personalized content of a sent transactional email * * @param string $uuid Unique id of the transactional email that has been sent to a particular contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacEmailContentAsyncWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetTransacEmailContent'; $request = $this->getTransacEmailContentRequest($uuid); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getTransacEmailContent' * * @param string $uuid Unique id of the transactional email that has been sent to a particular contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getTransacEmailContentRequest($uuid) { // verify the required parameter 'uuid' is set if ($uuid === null || (is_array($uuid) && count($uuid) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uuid when calling getTransacEmailContent' ); } $resourcePath = '/smtp/emails/{uuid}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($uuid !== null) { $resourcePath = str_replace( '{' . 'uuid' . '}', ObjectSerializer::toPathValue($uuid), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getTransacEmailsList * * Get the list of transactional emails on the basis of allowed filters * * @param string $email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) * @param int $templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) * @param string $messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param int $limit Number of documents returned per page (optional, default to 500) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetTransacEmailsList */ public function getTransacEmailsList($email = null, $templateId = null, $messageId = null, $startDate = null, $endDate = null, $sort = 'desc', $limit = '500', $offset = '0') { list($response) = $this->getTransacEmailsListWithHttpInfo($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset); return $response; } /** * Operation getTransacEmailsListWithHttpInfo * * Get the list of transactional emails on the basis of allowed filters * * @param string $email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) * @param int $templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) * @param string $messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param int $limit Number of documents returned per page (optional, default to 500) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetTransacEmailsList, HTTP status code, HTTP response headers (array of strings) */ public function getTransacEmailsListWithHttpInfo($email = null, $templateId = null, $messageId = null, $startDate = null, $endDate = null, $sort = 'desc', $limit = '500', $offset = '0') { $returnType = '\Brevo\Client\Model\GetTransacEmailsList'; $request = $this->getTransacEmailsListRequest($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetTransacEmailsList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getTransacEmailsListAsync * * Get the list of transactional emails on the basis of allowed filters * * @param string $email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) * @param int $templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) * @param string $messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param int $limit Number of documents returned per page (optional, default to 500) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacEmailsListAsync($email = null, $templateId = null, $messageId = null, $startDate = null, $endDate = null, $sort = 'desc', $limit = '500', $offset = '0') { return $this->getTransacEmailsListAsyncWithHttpInfo($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getTransacEmailsListAsyncWithHttpInfo * * Get the list of transactional emails on the basis of allowed filters * * @param string $email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) * @param int $templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) * @param string $messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param int $limit Number of documents returned per page (optional, default to 500) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getTransacEmailsListAsyncWithHttpInfo($email = null, $templateId = null, $messageId = null, $startDate = null, $endDate = null, $sort = 'desc', $limit = '500', $offset = '0') { $returnType = '\Brevo\Client\Model\GetTransacEmailsList'; $request = $this->getTransacEmailsListRequest($email, $templateId, $messageId, $startDate, $endDate, $sort, $limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getTransacEmailsList' * * @param string $email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional) * @param int $templateId Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional) * @param string $messageId Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param int $limit Number of documents returned per page (optional, default to 500) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getTransacEmailsListRequest($email = null, $templateId = null, $messageId = null, $startDate = null, $endDate = null, $sort = 'desc', $limit = '500', $offset = '0') { if ($limit !== null && $limit > 1000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getTransacEmailsList, must be smaller than or equal to 1000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalEmailsApi.getTransacEmailsList, must be bigger than or equal to 0.'); } $resourcePath = '/smtp/emails'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($email !== null) { $queryParams['email'] = ObjectSerializer::toQueryValue($email); } // query params if ($templateId !== null) { $queryParams['templateId'] = ObjectSerializer::toQueryValue($templateId); } // query params if ($messageId !== null) { $queryParams['messageId'] = ObjectSerializer::toQueryValue($messageId); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendTestTemplate * * Send a template to your test list * * @param int $templateId Id of the template (required) * @param \Brevo\Client\Model\SendTestEmail $sendTestEmail sendTestEmail (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendTestTemplate($templateId, $sendTestEmail) { $this->sendTestTemplateWithHttpInfo($templateId, $sendTestEmail); } /** * Operation sendTestTemplateWithHttpInfo * * Send a template to your test list * * @param int $templateId Id of the template (required) * @param \Brevo\Client\Model\SendTestEmail $sendTestEmail (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendTestTemplateWithHttpInfo($templateId, $sendTestEmail) { $returnType = ''; $request = $this->sendTestTemplateRequest($templateId, $sendTestEmail); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostSendFailed', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendTestTemplateAsync * * Send a template to your test list * * @param int $templateId Id of the template (required) * @param \Brevo\Client\Model\SendTestEmail $sendTestEmail (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestTemplateAsync($templateId, $sendTestEmail) { return $this->sendTestTemplateAsyncWithHttpInfo($templateId, $sendTestEmail) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendTestTemplateAsyncWithHttpInfo * * Send a template to your test list * * @param int $templateId Id of the template (required) * @param \Brevo\Client\Model\SendTestEmail $sendTestEmail (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestTemplateAsyncWithHttpInfo($templateId, $sendTestEmail) { $returnType = ''; $request = $this->sendTestTemplateRequest($templateId, $sendTestEmail); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendTestTemplate' * * @param int $templateId Id of the template (required) * @param \Brevo\Client\Model\SendTestEmail $sendTestEmail (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendTestTemplateRequest($templateId, $sendTestEmail) { // verify the required parameter 'templateId' is set if ($templateId === null || (is_array($templateId) && count($templateId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $templateId when calling sendTestTemplate' ); } // verify the required parameter 'sendTestEmail' is set if ($sendTestEmail === null || (is_array($sendTestEmail) && count($sendTestEmail) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendTestEmail when calling sendTestTemplate' ); } $resourcePath = '/smtp/templates/{templateId}/sendTest'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($templateId !== null) { $resourcePath = str_replace( '{' . 'templateId' . '}', ObjectSerializer::toPathValue($templateId), $resourcePath ); } // body params $_tempBody = null; if (isset($sendTestEmail)) { $_tempBody = $sendTestEmail; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendTransacEmail * * Send a transactional email * * @param \Brevo\Client\Model\SendSmtpEmail $sendSmtpEmail Values to send a transactional email (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateSmtpEmail */ public function sendTransacEmail($sendSmtpEmail) { list($response) = $this->sendTransacEmailWithHttpInfo($sendSmtpEmail); return $response; } /** * Operation sendTransacEmailWithHttpInfo * * Send a transactional email * * @param \Brevo\Client\Model\SendSmtpEmail $sendSmtpEmail Values to send a transactional email (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateSmtpEmail, HTTP status code, HTTP response headers (array of strings) */ public function sendTransacEmailWithHttpInfo($sendSmtpEmail) { $returnType = '\Brevo\Client\Model\CreateSmtpEmail'; $request = $this->sendTransacEmailRequest($sendSmtpEmail); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateSmtpEmail', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ScheduleSmtpEmail', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendTransacEmailAsync * * Send a transactional email * * @param \Brevo\Client\Model\SendSmtpEmail $sendSmtpEmail Values to send a transactional email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTransacEmailAsync($sendSmtpEmail) { return $this->sendTransacEmailAsyncWithHttpInfo($sendSmtpEmail) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendTransacEmailAsyncWithHttpInfo * * Send a transactional email * * @param \Brevo\Client\Model\SendSmtpEmail $sendSmtpEmail Values to send a transactional email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTransacEmailAsyncWithHttpInfo($sendSmtpEmail) { $returnType = '\Brevo\Client\Model\CreateSmtpEmail'; $request = $this->sendTransacEmailRequest($sendSmtpEmail); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendTransacEmail' * * @param \Brevo\Client\Model\SendSmtpEmail $sendSmtpEmail Values to send a transactional email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendTransacEmailRequest($sendSmtpEmail) { // verify the required parameter 'sendSmtpEmail' is set if ($sendSmtpEmail === null || (is_array($sendSmtpEmail) && count($sendSmtpEmail) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendSmtpEmail when calling sendTransacEmail' ); } $resourcePath = '/smtp/email'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($sendSmtpEmail)) { $_tempBody = $sendSmtpEmail; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation smtpBlockedContactsEmailDelete * * Unblock or resubscribe a transactional contact * * @param string $email contact email (urlencoded) to unblock. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function smtpBlockedContactsEmailDelete($email) { $this->smtpBlockedContactsEmailDeleteWithHttpInfo($email); } /** * Operation smtpBlockedContactsEmailDeleteWithHttpInfo * * Unblock or resubscribe a transactional contact * * @param string $email contact email (urlencoded) to unblock. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function smtpBlockedContactsEmailDeleteWithHttpInfo($email) { $returnType = ''; $request = $this->smtpBlockedContactsEmailDeleteRequest($email); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation smtpBlockedContactsEmailDeleteAsync * * Unblock or resubscribe a transactional contact * * @param string $email contact email (urlencoded) to unblock. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function smtpBlockedContactsEmailDeleteAsync($email) { return $this->smtpBlockedContactsEmailDeleteAsyncWithHttpInfo($email) ->then( function ($response) { return $response[0]; } ); } /** * Operation smtpBlockedContactsEmailDeleteAsyncWithHttpInfo * * Unblock or resubscribe a transactional contact * * @param string $email contact email (urlencoded) to unblock. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function smtpBlockedContactsEmailDeleteAsyncWithHttpInfo($email) { $returnType = ''; $request = $this->smtpBlockedContactsEmailDeleteRequest($email); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'smtpBlockedContactsEmailDelete' * * @param string $email contact email (urlencoded) to unblock. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function smtpBlockedContactsEmailDeleteRequest($email) { // verify the required parameter 'email' is set if ($email === null || (is_array($email) && count($email) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $email when calling smtpBlockedContactsEmailDelete' ); } $resourcePath = '/smtp/blockedContacts/{email}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($email !== null) { $resourcePath = str_replace( '{' . 'email' . '}', ObjectSerializer::toPathValue($email), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation smtpLogMessageIdDelete * * Delete an SMTP transactional log * * @param string $messageId MessageId of the transactional log to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function smtpLogMessageIdDelete($messageId) { $this->smtpLogMessageIdDeleteWithHttpInfo($messageId); } /** * Operation smtpLogMessageIdDeleteWithHttpInfo * * Delete an SMTP transactional log * * @param string $messageId MessageId of the transactional log to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function smtpLogMessageIdDeleteWithHttpInfo($messageId) { $returnType = ''; $request = $this->smtpLogMessageIdDeleteRequest($messageId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation smtpLogMessageIdDeleteAsync * * Delete an SMTP transactional log * * @param string $messageId MessageId of the transactional log to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function smtpLogMessageIdDeleteAsync($messageId) { return $this->smtpLogMessageIdDeleteAsyncWithHttpInfo($messageId) ->then( function ($response) { return $response[0]; } ); } /** * Operation smtpLogMessageIdDeleteAsyncWithHttpInfo * * Delete an SMTP transactional log * * @param string $messageId MessageId of the transactional log to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function smtpLogMessageIdDeleteAsyncWithHttpInfo($messageId) { $returnType = ''; $request = $this->smtpLogMessageIdDeleteRequest($messageId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'smtpLogMessageIdDelete' * * @param string $messageId MessageId of the transactional log to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function smtpLogMessageIdDeleteRequest($messageId) { // verify the required parameter 'messageId' is set if ($messageId === null || (is_array($messageId) && count($messageId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $messageId when calling smtpLogMessageIdDelete' ); } $resourcePath = '/smtp/log/{messageId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($messageId !== null) { $resourcePath = str_replace( '{' . 'messageId' . '}', ObjectSerializer::toPathValue($messageId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateSmtpTemplate * * Update an email template * * @param int $templateId id of the template (required) * @param \Brevo\Client\Model\UpdateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateSmtpTemplate($templateId, $smtpTemplate) { $this->updateSmtpTemplateWithHttpInfo($templateId, $smtpTemplate); } /** * Operation updateSmtpTemplateWithHttpInfo * * Update an email template * * @param int $templateId id of the template (required) * @param \Brevo\Client\Model\UpdateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateSmtpTemplateWithHttpInfo($templateId, $smtpTemplate) { $returnType = ''; $request = $this->updateSmtpTemplateRequest($templateId, $smtpTemplate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateSmtpTemplateAsync * * Update an email template * * @param int $templateId id of the template (required) * @param \Brevo\Client\Model\UpdateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmtpTemplateAsync($templateId, $smtpTemplate) { return $this->updateSmtpTemplateAsyncWithHttpInfo($templateId, $smtpTemplate) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateSmtpTemplateAsyncWithHttpInfo * * Update an email template * * @param int $templateId id of the template (required) * @param \Brevo\Client\Model\UpdateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmtpTemplateAsyncWithHttpInfo($templateId, $smtpTemplate) { $returnType = ''; $request = $this->updateSmtpTemplateRequest($templateId, $smtpTemplate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateSmtpTemplate' * * @param int $templateId id of the template (required) * @param \Brevo\Client\Model\UpdateSmtpTemplate $smtpTemplate values to update in transactional email template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateSmtpTemplateRequest($templateId, $smtpTemplate) { // verify the required parameter 'templateId' is set if ($templateId === null || (is_array($templateId) && count($templateId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $templateId when calling updateSmtpTemplate' ); } // verify the required parameter 'smtpTemplate' is set if ($smtpTemplate === null || (is_array($smtpTemplate) && count($smtpTemplate) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $smtpTemplate when calling updateSmtpTemplate' ); } $resourcePath = '/smtp/templates/{templateId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($templateId !== null) { $resourcePath = str_replace( '{' . 'templateId' . '}', ObjectSerializer::toPathValue($templateId), $resourcePath ); } // body params $_tempBody = null; if (isset($smtpTemplate)) { $_tempBody = $smtpTemplate; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/AccountApi.php 0000644 00000062555 15021222673 0012501 0 ustar 00 <?php /** * AccountApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * AccountApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AccountApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getAccount * * Get your account information, plan and credits details * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAccount */ public function getAccount() { list($response) = $this->getAccountWithHttpInfo(); return $response; } /** * Operation getAccountWithHttpInfo * * Get your account information, plan and credits details * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAccount, HTTP status code, HTTP response headers (array of strings) */ public function getAccountWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAccount'; $request = $this->getAccountRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAccount', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAccountAsync * * Get your account information, plan and credits details * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountAsync() { return $this->getAccountAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getAccountAsyncWithHttpInfo * * Get your account information, plan and credits details * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAccount'; $request = $this->getAccountRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAccount' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAccountRequest() { $resourcePath = '/account'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAccountActivity * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAccountActivity */ public function getAccountActivity($startDate = null, $endDate = null, $limit = '10', $offset = '0') { list($response) = $this->getAccountActivityWithHttpInfo($startDate, $endDate, $limit, $offset); return $response; } /** * Operation getAccountActivityWithHttpInfo * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAccountActivity, HTTP status code, HTTP response headers (array of strings) */ public function getAccountActivityWithHttpInfo($startDate = null, $endDate = null, $limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAccountActivity'; $request = $this->getAccountActivityRequest($startDate, $endDate, $limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAccountActivity', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAccountActivityAsync * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountActivityAsync($startDate = null, $endDate = null, $limit = '10', $offset = '0') { return $this->getAccountActivityAsyncWithHttpInfo($startDate, $endDate, $limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getAccountActivityAsyncWithHttpInfo * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountActivityAsyncWithHttpInfo($startDate = null, $endDate = null, $limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAccountActivity'; $request = $this->getAccountActivityRequest($startDate, $endDate, $limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAccountActivity' * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAccountActivityRequest($startDate = null, $endDate = null, $limit = '10', $offset = '0') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling AccountApi.getAccountActivity, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 1) { throw new \InvalidArgumentException('invalid value for "$limit" when calling AccountApi.getAccountActivity, must be bigger than or equal to 1.'); } $resourcePath = '/organization/activities'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ContactsApi.php 0000644 00001146352 15021222673 0012662 0 ustar 00 <?php /** * ContactsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ContactsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ContactsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation addContactToList * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\PostContactInfo */ public function addContactToList($listId, $contactEmails) { list($response) = $this->addContactToListWithHttpInfo($listId, $contactEmails); return $response; } /** * Operation addContactToListWithHttpInfo * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\PostContactInfo, HTTP status code, HTTP response headers (array of strings) */ public function addContactToListWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->addContactToListRequest($listId, $contactEmails); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostContactInfo', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation addContactToListAsync * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addContactToListAsync($listId, $contactEmails) { return $this->addContactToListAsyncWithHttpInfo($listId, $contactEmails) ->then( function ($response) { return $response[0]; } ); } /** * Operation addContactToListAsyncWithHttpInfo * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addContactToListAsyncWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->addContactToListRequest($listId, $contactEmails); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'addContactToList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function addContactToListRequest($listId, $contactEmails) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling addContactToList' ); } // verify the required parameter 'contactEmails' is set if ($contactEmails === null || (is_array($contactEmails) && count($contactEmails) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $contactEmails when calling addContactToList' ); } $resourcePath = '/contacts/lists/{listId}/contacts/add'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($contactEmails)) { $_tempBody = $contactEmails; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createAttribute * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createAttribute($attributeCategory, $attributeName, $createAttribute) { $this->createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute); } /** * Operation createAttributeWithHttpInfo * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createAttributeWithHttpInfo($attributeCategory, $attributeName, $createAttribute) { $returnType = ''; $request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createAttributeAsync * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createAttributeAsync($attributeCategory, $attributeName, $createAttribute) { return $this->createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute) ->then( function ($response) { return $response[0]; } ); } /** * Operation createAttributeAsyncWithHttpInfo * * Create contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $createAttribute) { $returnType = ''; $request = $this->createAttributeRequest($attributeCategory, $attributeName, $createAttribute); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the attribute (required) * @param \Brevo\Client\Model\CreateAttribute $createAttribute Values to create an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createAttributeRequest($attributeCategory, $attributeName, $createAttribute) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling createAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling createAttribute' ); } // verify the required parameter 'createAttribute' is set if ($createAttribute === null || (is_array($createAttribute) && count($createAttribute) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createAttribute when calling createAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if (isset($createAttribute)) { $_tempBody = $createAttribute; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createContact * * Create a contact * * @param \Brevo\Client\Model\CreateContact $createContact Values to create a contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateUpdateContactModel */ public function createContact($createContact) { list($response) = $this->createContactWithHttpInfo($createContact); return $response; } /** * Operation createContactWithHttpInfo * * Create a contact * * @param \Brevo\Client\Model\CreateContact $createContact Values to create a contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateUpdateContactModel, HTTP status code, HTTP response headers (array of strings) */ public function createContactWithHttpInfo($createContact) { $returnType = '\Brevo\Client\Model\CreateUpdateContactModel'; $request = $this->createContactRequest($createContact); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateUpdateContactModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createContactAsync * * Create a contact * * @param \Brevo\Client\Model\CreateContact $createContact Values to create a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createContactAsync($createContact) { return $this->createContactAsyncWithHttpInfo($createContact) ->then( function ($response) { return $response[0]; } ); } /** * Operation createContactAsyncWithHttpInfo * * Create a contact * * @param \Brevo\Client\Model\CreateContact $createContact Values to create a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createContactAsyncWithHttpInfo($createContact) { $returnType = '\Brevo\Client\Model\CreateUpdateContactModel'; $request = $this->createContactRequest($createContact); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createContact' * * @param \Brevo\Client\Model\CreateContact $createContact Values to create a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createContactRequest($createContact) { // verify the required parameter 'createContact' is set if ($createContact === null || (is_array($createContact) && count($createContact) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createContact when calling createContact' ); } $resourcePath = '/contacts'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createContact)) { $_tempBody = $createContact; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createDoiContact * * Create Contact via DOI (Double-Opt-In) Flow * * @param \Brevo\Client\Model\CreateDoiContact $createDoiContact Values to create the Double opt-in (DOI) contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createDoiContact($createDoiContact) { $this->createDoiContactWithHttpInfo($createDoiContact); } /** * Operation createDoiContactWithHttpInfo * * Create Contact via DOI (Double-Opt-In) Flow * * @param \Brevo\Client\Model\CreateDoiContact $createDoiContact Values to create the Double opt-in (DOI) contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createDoiContactWithHttpInfo($createDoiContact) { $returnType = ''; $request = $this->createDoiContactRequest($createDoiContact); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createDoiContactAsync * * Create Contact via DOI (Double-Opt-In) Flow * * @param \Brevo\Client\Model\CreateDoiContact $createDoiContact Values to create the Double opt-in (DOI) contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createDoiContactAsync($createDoiContact) { return $this->createDoiContactAsyncWithHttpInfo($createDoiContact) ->then( function ($response) { return $response[0]; } ); } /** * Operation createDoiContactAsyncWithHttpInfo * * Create Contact via DOI (Double-Opt-In) Flow * * @param \Brevo\Client\Model\CreateDoiContact $createDoiContact Values to create the Double opt-in (DOI) contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createDoiContactAsyncWithHttpInfo($createDoiContact) { $returnType = ''; $request = $this->createDoiContactRequest($createDoiContact); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createDoiContact' * * @param \Brevo\Client\Model\CreateDoiContact $createDoiContact Values to create the Double opt-in (DOI) contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createDoiContactRequest($createDoiContact) { // verify the required parameter 'createDoiContact' is set if ($createDoiContact === null || (is_array($createDoiContact) && count($createDoiContact) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createDoiContact when calling createDoiContact' ); } $resourcePath = '/contacts/doubleOptinConfirmation'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createDoiContact)) { $_tempBody = $createDoiContact; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createFolder * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createFolder($createFolder) { list($response) = $this->createFolderWithHttpInfo($createFolder); return $response; } /** * Operation createFolderWithHttpInfo * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createFolderWithHttpInfo($createFolder) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createFolderRequest($createFolder); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createFolderAsync * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createFolderAsync($createFolder) { return $this->createFolderAsyncWithHttpInfo($createFolder) ->then( function ($response) { return $response[0]; } ); } /** * Operation createFolderAsyncWithHttpInfo * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createFolderAsyncWithHttpInfo($createFolder) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createFolderRequest($createFolder); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createFolder' * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createFolderRequest($createFolder) { // verify the required parameter 'createFolder' is set if ($createFolder === null || (is_array($createFolder) && count($createFolder) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createFolder when calling createFolder' ); } $resourcePath = '/contacts/folders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createFolder)) { $_tempBody = $createFolder; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createList * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createList($createList) { list($response) = $this->createListWithHttpInfo($createList); return $response; } /** * Operation createListWithHttpInfo * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createListWithHttpInfo($createList) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createListRequest($createList); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createListAsync * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createListAsync($createList) { return $this->createListAsyncWithHttpInfo($createList) ->then( function ($response) { return $response[0]; } ); } /** * Operation createListAsyncWithHttpInfo * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createListAsyncWithHttpInfo($createList) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createListRequest($createList); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createList' * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createListRequest($createList) { // verify the required parameter 'createList' is set if ($createList === null || (is_array($createList) && count($createList) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createList when calling createList' ); } $resourcePath = '/contacts/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createList)) { $_tempBody = $createList; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteAttribute * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteAttribute($attributeCategory, $attributeName) { $this->deleteAttributeWithHttpInfo($attributeCategory, $attributeName); } /** * Operation deleteAttributeWithHttpInfo * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteAttributeWithHttpInfo($attributeCategory, $attributeName) { $returnType = ''; $request = $this->deleteAttributeRequest($attributeCategory, $attributeName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteAttributeAsync * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteAttributeAsync($attributeCategory, $attributeName) { return $this->deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteAttributeAsyncWithHttpInfo * * Delete an attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteAttributeAsyncWithHttpInfo($attributeCategory, $attributeName) { $returnType = ''; $request = $this->deleteAttributeRequest($attributeCategory, $attributeName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteAttributeRequest($attributeCategory, $attributeName) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling deleteAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling deleteAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteContact * * Delete a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteContact($identifier) { $this->deleteContactWithHttpInfo($identifier); } /** * Operation deleteContactWithHttpInfo * * Delete a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteContactWithHttpInfo($identifier) { $returnType = ''; $request = $this->deleteContactRequest($identifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 405: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteContactAsync * * Delete a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteContactAsync($identifier) { return $this->deleteContactAsyncWithHttpInfo($identifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteContactAsyncWithHttpInfo * * Delete a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteContactAsyncWithHttpInfo($identifier) { $returnType = ''; $request = $this->deleteContactRequest($identifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteContact' * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteContactRequest($identifier) { // verify the required parameter 'identifier' is set if ($identifier === null || (is_array($identifier) && count($identifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $identifier when calling deleteContact' ); } $resourcePath = '/contacts/{identifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($identifier !== null) { $resourcePath = str_replace( '{' . 'identifier' . '}', ObjectSerializer::toPathValue($identifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteFolder * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteFolder($folderId) { $this->deleteFolderWithHttpInfo($folderId); } /** * Operation deleteFolderWithHttpInfo * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteFolderWithHttpInfo($folderId) { $returnType = ''; $request = $this->deleteFolderRequest($folderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteFolderAsync * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteFolderAsync($folderId) { return $this->deleteFolderAsyncWithHttpInfo($folderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteFolderAsyncWithHttpInfo * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteFolderAsyncWithHttpInfo($folderId) { $returnType = ''; $request = $this->deleteFolderRequest($folderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteFolder' * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteFolderRequest($folderId) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling deleteFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteList * * Delete a list * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteList($listId) { $this->deleteListWithHttpInfo($listId); } /** * Operation deleteListWithHttpInfo * * Delete a list * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteListWithHttpInfo($listId) { $returnType = ''; $request = $this->deleteListRequest($listId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteListAsync * * Delete a list * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteListAsync($listId) { return $this->deleteListAsyncWithHttpInfo($listId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteListAsyncWithHttpInfo * * Delete a list * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteListAsyncWithHttpInfo($listId) { $returnType = ''; $request = $this->deleteListRequest($listId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteList' * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteListRequest($listId) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling deleteList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAttributes * * List all attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAttributes */ public function getAttributes() { list($response) = $this->getAttributesWithHttpInfo(); return $response; } /** * Operation getAttributesWithHttpInfo * * List all attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAttributes, HTTP status code, HTTP response headers (array of strings) */ public function getAttributesWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAttributes'; $request = $this->getAttributesRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAttributes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAttributesAsync * * List all attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAttributesAsync() { return $this->getAttributesAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getAttributesAsyncWithHttpInfo * * List all attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAttributesAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetAttributes'; $request = $this->getAttributesRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAttributes' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAttributesRequest() { $resourcePath = '/contacts/attributes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getContactInfo * * Get a contact's details * * @param string $identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) * @param string $startDate **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetExtendedContactDetails */ public function getContactInfo($identifier, $startDate = null, $endDate = null) { list($response) = $this->getContactInfoWithHttpInfo($identifier, $startDate, $endDate); return $response; } /** * Operation getContactInfoWithHttpInfo * * Get a contact's details * * @param string $identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) * @param string $startDate **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetExtendedContactDetails, HTTP status code, HTTP response headers (array of strings) */ public function getContactInfoWithHttpInfo($identifier, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetExtendedContactDetails'; $request = $this->getContactInfoRequest($identifier, $startDate, $endDate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetExtendedContactDetails', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getContactInfoAsync * * Get a contact's details * * @param string $identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) * @param string $startDate **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactInfoAsync($identifier, $startDate = null, $endDate = null) { return $this->getContactInfoAsyncWithHttpInfo($identifier, $startDate, $endDate) ->then( function ($response) { return $response[0]; } ); } /** * Operation getContactInfoAsyncWithHttpInfo * * Get a contact's details * * @param string $identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) * @param string $startDate **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactInfoAsyncWithHttpInfo($identifier, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetExtendedContactDetails'; $request = $this->getContactInfoRequest($identifier, $startDate, $endDate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getContactInfo' * * @param string $identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value (required) * @param string $startDate **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getContactInfoRequest($identifier, $startDate = null, $endDate = null) { // verify the required parameter 'identifier' is set if ($identifier === null || (is_array($identifier) && count($identifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $identifier when calling getContactInfo' ); } $resourcePath = '/contacts/{identifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // path params if ($identifier !== null) { $resourcePath = str_replace( '{' . 'identifier' . '}', ObjectSerializer::toPathValue($identifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getContactStats * * Get email campaigns' statistics for a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetContactCampaignStats */ public function getContactStats($identifier, $startDate = null, $endDate = null) { list($response) = $this->getContactStatsWithHttpInfo($identifier, $startDate, $endDate); return $response; } /** * Operation getContactStatsWithHttpInfo * * Get email campaigns' statistics for a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetContactCampaignStats, HTTP status code, HTTP response headers (array of strings) */ public function getContactStatsWithHttpInfo($identifier, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetContactCampaignStats'; $request = $this->getContactStatsRequest($identifier, $startDate, $endDate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetContactCampaignStats', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getContactStatsAsync * * Get email campaigns' statistics for a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactStatsAsync($identifier, $startDate = null, $endDate = null) { return $this->getContactStatsAsyncWithHttpInfo($identifier, $startDate, $endDate) ->then( function ($response) { return $response[0]; } ); } /** * Operation getContactStatsAsyncWithHttpInfo * * Get email campaigns' statistics for a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactStatsAsyncWithHttpInfo($identifier, $startDate = null, $endDate = null) { $returnType = '\Brevo\Client\Model\GetContactCampaignStats'; $request = $this->getContactStatsRequest($identifier, $startDate, $endDate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getContactStats' * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getContactStatsRequest($identifier, $startDate = null, $endDate = null) { // verify the required parameter 'identifier' is set if ($identifier === null || (is_array($identifier) && count($identifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $identifier when calling getContactStats' ); } $resourcePath = '/contacts/{identifier}/campaignStats'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // path params if ($identifier !== null) { $resourcePath = str_replace( '{' . 'identifier' . '}', ObjectSerializer::toPathValue($identifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getContacts * * Get all the contacts * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetContacts */ public function getContacts($limit = '50', $offset = '0', $modifiedSince = null, $createdSince = null, $sort = 'desc') { list($response) = $this->getContactsWithHttpInfo($limit, $offset, $modifiedSince, $createdSince, $sort); return $response; } /** * Operation getContactsWithHttpInfo * * Get all the contacts * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetContacts, HTTP status code, HTTP response headers (array of strings) */ public function getContactsWithHttpInfo($limit = '50', $offset = '0', $modifiedSince = null, $createdSince = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsRequest($limit, $offset, $modifiedSince, $createdSince, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetContacts', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getContactsAsync * * Get all the contacts * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsAsync($limit = '50', $offset = '0', $modifiedSince = null, $createdSince = null, $sort = 'desc') { return $this->getContactsAsyncWithHttpInfo($limit, $offset, $modifiedSince, $createdSince, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getContactsAsyncWithHttpInfo * * Get all the contacts * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsAsyncWithHttpInfo($limit = '50', $offset = '0', $modifiedSince = null, $createdSince = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsRequest($limit, $offset, $modifiedSince, $createdSince, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getContacts' * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getContactsRequest($limit = '50', $offset = '0', $modifiedSince = null, $createdSince = null, $sort = 'desc') { if ($limit !== null && $limit > 1000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getContacts, must be smaller than or equal to 1000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getContacts, must be bigger than or equal to 0.'); } $resourcePath = '/contacts'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($modifiedSince !== null) { $queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince); } // query params if ($createdSince !== null) { $queryParams['createdSince'] = ObjectSerializer::toQueryValue($createdSince); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getContactsFromList * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetContacts */ public function getContactsFromList($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getContactsFromListWithHttpInfo($listId, $modifiedSince, $limit, $offset, $sort); return $response; } /** * Operation getContactsFromListWithHttpInfo * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetContacts, HTTP status code, HTTP response headers (array of strings) */ public function getContactsFromListWithHttpInfo($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsFromListRequest($listId, $modifiedSince, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetContacts', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getContactsFromListAsync * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsFromListAsync($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { return $this->getContactsFromListAsyncWithHttpInfo($listId, $modifiedSince, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getContactsFromListAsyncWithHttpInfo * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsFromListAsyncWithHttpInfo($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsFromListRequest($listId, $modifiedSince, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getContactsFromList' * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getContactsFromListRequest($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling getContactsFromList' ); } if ($limit !== null && $limit > 500) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getContactsFromList, must be smaller than or equal to 500.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getContactsFromList, must be bigger than or equal to 0.'); } $resourcePath = '/contacts/lists/{listId}/contacts'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($modifiedSince !== null) { $queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolder * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolder */ public function getFolder($folderId) { list($response) = $this->getFolderWithHttpInfo($folderId); return $response; } /** * Operation getFolderWithHttpInfo * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolder, HTTP status code, HTTP response headers (array of strings) */ public function getFolderWithHttpInfo($folderId) { $returnType = '\Brevo\Client\Model\GetFolder'; $request = $this->getFolderRequest($folderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolder', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFolderAsync * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderAsync($folderId) { return $this->getFolderAsyncWithHttpInfo($folderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFolderAsyncWithHttpInfo * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderAsyncWithHttpInfo($folderId) { $returnType = '\Brevo\Client\Model\GetFolder'; $request = $this->getFolderRequest($folderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolder' * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFolderRequest($folderId) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling getFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolderLists * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolderLists */ public function getFolderLists($folderId, $limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getFolderListsWithHttpInfo($folderId, $limit, $offset, $sort); return $response; } /** * Operation getFolderListsWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolderLists, HTTP status code, HTTP response headers (array of strings) */ public function getFolderListsWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolderLists', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFolderListsAsync * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsync($folderId, $limit = '10', $offset = '0', $sort = 'desc') { return $this->getFolderListsAsyncWithHttpInfo($folderId, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFolderListsAsyncWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsyncWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolderLists' * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFolderListsRequest($folderId, $limit = '10', $offset = '0', $sort = 'desc') { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling getFolderLists' ); } if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getFolderLists, must be smaller than or equal to 50.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getFolderLists, must be bigger than or equal to 0.'); } $resourcePath = '/contacts/folders/{folderId}/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolders * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolders */ public function getFolders($limit, $offset, $sort = 'desc') { list($response) = $this->getFoldersWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getFoldersWithHttpInfo * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolders, HTTP status code, HTTP response headers (array of strings) */ public function getFoldersWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolders'; $request = $this->getFoldersRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolders', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFoldersAsync * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFoldersAsync($limit, $offset, $sort = 'desc') { return $this->getFoldersAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFoldersAsyncWithHttpInfo * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFoldersAsyncWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolders'; $request = $this->getFoldersRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolders' * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFoldersRequest($limit, $offset, $sort = 'desc') { // verify the required parameter 'limit' is set if ($limit === null || (is_array($limit) && count($limit) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $limit when calling getFolders' ); } if ($limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getFolders, must be smaller than or equal to 50.'); } if ($limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getFolders, must be bigger than or equal to 0.'); } // verify the required parameter 'offset' is set if ($offset === null || (is_array($offset) && count($offset) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $offset when calling getFolders' ); } $resourcePath = '/contacts/folders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getList * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetExtendedList */ public function getList($listId) { list($response) = $this->getListWithHttpInfo($listId); return $response; } /** * Operation getListWithHttpInfo * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetExtendedList, HTTP status code, HTTP response headers (array of strings) */ public function getListWithHttpInfo($listId) { $returnType = '\Brevo\Client\Model\GetExtendedList'; $request = $this->getListRequest($listId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetExtendedList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getListAsync * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListAsync($listId) { return $this->getListAsyncWithHttpInfo($listId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getListAsyncWithHttpInfo * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListAsyncWithHttpInfo($listId) { $returnType = '\Brevo\Client\Model\GetExtendedList'; $request = $this->getListRequest($listId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getList' * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getListRequest($listId) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling getList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getLists * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetLists */ public function getLists($limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getListsWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getListsWithHttpInfo * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetLists, HTTP status code, HTTP response headers (array of strings) */ public function getListsWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetLists'; $request = $this->getListsRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetLists', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getListsAsync * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListsAsync($limit = '10', $offset = '0', $sort = 'desc') { return $this->getListsAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getListsAsyncWithHttpInfo * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListsAsyncWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetLists'; $request = $this->getListsRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getLists' * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getListsRequest($limit = '10', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getLists, must be smaller than or equal to 50.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getLists, must be bigger than or equal to 0.'); } $resourcePath = '/contacts/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSegments * * Get all the Segments * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSegments */ public function getSegments($limit, $offset, $sort = 'desc') { list($response) = $this->getSegmentsWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getSegmentsWithHttpInfo * * Get all the Segments * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSegments, HTTP status code, HTTP response headers (array of strings) */ public function getSegmentsWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSegments'; $request = $this->getSegmentsRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSegments', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSegmentsAsync * * Get all the Segments * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSegmentsAsync($limit, $offset, $sort = 'desc') { return $this->getSegmentsAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSegmentsAsyncWithHttpInfo * * Get all the Segments * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSegmentsAsyncWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSegments'; $request = $this->getSegmentsRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSegments' * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSegmentsRequest($limit, $offset, $sort = 'desc') { // verify the required parameter 'limit' is set if ($limit === null || (is_array($limit) && count($limit) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $limit when calling getSegments' ); } if ($limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getSegments, must be smaller than or equal to 50.'); } if ($limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ContactsApi.getSegments, must be bigger than or equal to 0.'); } // verify the required parameter 'offset' is set if ($offset === null || (is_array($offset) && count($offset) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $offset when calling getSegments' ); } $resourcePath = '/contacts/segments'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation importContacts * * Import contacts * * @param \Brevo\Client\Model\RequestContactImport $requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreatedProcessId */ public function importContacts($requestContactImport) { list($response) = $this->importContactsWithHttpInfo($requestContactImport); return $response; } /** * Operation importContactsWithHttpInfo * * Import contacts * * @param \Brevo\Client\Model\RequestContactImport $requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ public function importContactsWithHttpInfo($requestContactImport) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->importContactsRequest($requestContactImport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreatedProcessId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation importContactsAsync * * Import contacts * * @param \Brevo\Client\Model\RequestContactImport $requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function importContactsAsync($requestContactImport) { return $this->importContactsAsyncWithHttpInfo($requestContactImport) ->then( function ($response) { return $response[0]; } ); } /** * Operation importContactsAsyncWithHttpInfo * * Import contacts * * @param \Brevo\Client\Model\RequestContactImport $requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function importContactsAsyncWithHttpInfo($requestContactImport) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->importContactsRequest($requestContactImport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'importContacts' * * @param \Brevo\Client\Model\RequestContactImport $requestContactImport Values to import contacts in Brevo. To know more about the expected format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns`` (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function importContactsRequest($requestContactImport) { // verify the required parameter 'requestContactImport' is set if ($requestContactImport === null || (is_array($requestContactImport) && count($requestContactImport) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $requestContactImport when calling importContacts' ); } $resourcePath = '/contacts/import'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($requestContactImport)) { $_tempBody = $requestContactImport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation removeContactFromList * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\PostContactInfo */ public function removeContactFromList($listId, $contactEmails) { list($response) = $this->removeContactFromListWithHttpInfo($listId, $contactEmails); return $response; } /** * Operation removeContactFromListWithHttpInfo * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\PostContactInfo, HTTP status code, HTTP response headers (array of strings) */ public function removeContactFromListWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->removeContactFromListRequest($listId, $contactEmails); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostContactInfo', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation removeContactFromListAsync * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeContactFromListAsync($listId, $contactEmails) { return $this->removeContactFromListAsyncWithHttpInfo($listId, $contactEmails) ->then( function ($response) { return $response[0]; } ); } /** * Operation removeContactFromListAsyncWithHttpInfo * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeContactFromListAsyncWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->removeContactFromListRequest($listId, $contactEmails); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'removeContactFromList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function removeContactFromListRequest($listId, $contactEmails) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling removeContactFromList' ); } // verify the required parameter 'contactEmails' is set if ($contactEmails === null || (is_array($contactEmails) && count($contactEmails) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $contactEmails when calling removeContactFromList' ); } $resourcePath = '/contacts/lists/{listId}/contacts/remove'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($contactEmails)) { $_tempBody = $contactEmails; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation requestContactExport * * Export contacts * * @param \Brevo\Client\Model\RequestContactExport $requestContactExport Values to request a contact export (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreatedProcessId */ public function requestContactExport($requestContactExport) { list($response) = $this->requestContactExportWithHttpInfo($requestContactExport); return $response; } /** * Operation requestContactExportWithHttpInfo * * Export contacts * * @param \Brevo\Client\Model\RequestContactExport $requestContactExport Values to request a contact export (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ public function requestContactExportWithHttpInfo($requestContactExport) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->requestContactExportRequest($requestContactExport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreatedProcessId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation requestContactExportAsync * * Export contacts * * @param \Brevo\Client\Model\RequestContactExport $requestContactExport Values to request a contact export (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function requestContactExportAsync($requestContactExport) { return $this->requestContactExportAsyncWithHttpInfo($requestContactExport) ->then( function ($response) { return $response[0]; } ); } /** * Operation requestContactExportAsyncWithHttpInfo * * Export contacts * * @param \Brevo\Client\Model\RequestContactExport $requestContactExport Values to request a contact export (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function requestContactExportAsyncWithHttpInfo($requestContactExport) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->requestContactExportRequest($requestContactExport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'requestContactExport' * * @param \Brevo\Client\Model\RequestContactExport $requestContactExport Values to request a contact export (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function requestContactExportRequest($requestContactExport) { // verify the required parameter 'requestContactExport' is set if ($requestContactExport === null || (is_array($requestContactExport) && count($requestContactExport) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $requestContactExport when calling requestContactExport' ); } $resourcePath = '/contacts/export'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($requestContactExport)) { $_tempBody = $requestContactExport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateAttribute * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateAttribute($attributeCategory, $attributeName, $updateAttribute) { $this->updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute); } /** * Operation updateAttributeWithHttpInfo * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateAttributeWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) { $returnType = ''; $request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateAttributeAsync * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateAttributeAsync($attributeCategory, $attributeName, $updateAttribute) { return $this->updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateAttributeAsyncWithHttpInfo * * Update contact attribute * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateAttributeAsyncWithHttpInfo($attributeCategory, $attributeName, $updateAttribute) { $returnType = ''; $request = $this->updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateAttribute' * * @param string $attributeCategory Category of the attribute (required) * @param string $attributeName Name of the existing attribute (required) * @param \Brevo\Client\Model\UpdateAttribute $updateAttribute Values to update an attribute (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateAttributeRequest($attributeCategory, $attributeName, $updateAttribute) { // verify the required parameter 'attributeCategory' is set if ($attributeCategory === null || (is_array($attributeCategory) && count($attributeCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeCategory when calling updateAttribute' ); } // verify the required parameter 'attributeName' is set if ($attributeName === null || (is_array($attributeName) && count($attributeName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $attributeName when calling updateAttribute' ); } // verify the required parameter 'updateAttribute' is set if ($updateAttribute === null || (is_array($updateAttribute) && count($updateAttribute) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateAttribute when calling updateAttribute' ); } $resourcePath = '/contacts/attributes/{attributeCategory}/{attributeName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($attributeCategory !== null) { $resourcePath = str_replace( '{' . 'attributeCategory' . '}', ObjectSerializer::toPathValue($attributeCategory), $resourcePath ); } // path params if ($attributeName !== null) { $resourcePath = str_replace( '{' . 'attributeName' . '}', ObjectSerializer::toPathValue($attributeName), $resourcePath ); } // body params $_tempBody = null; if (isset($updateAttribute)) { $_tempBody = $updateAttribute; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateBatchContacts * * Update multiple contacts * * @param \Brevo\Client\Model\UpdateBatchContacts $updateBatchContacts Values to update multiple contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateBatchContacts($updateBatchContacts) { $this->updateBatchContactsWithHttpInfo($updateBatchContacts); } /** * Operation updateBatchContactsWithHttpInfo * * Update multiple contacts * * @param \Brevo\Client\Model\UpdateBatchContacts $updateBatchContacts Values to update multiple contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateBatchContactsWithHttpInfo($updateBatchContacts) { $returnType = ''; $request = $this->updateBatchContactsRequest($updateBatchContacts); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateBatchContactsAsync * * Update multiple contacts * * @param \Brevo\Client\Model\UpdateBatchContacts $updateBatchContacts Values to update multiple contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateBatchContactsAsync($updateBatchContacts) { return $this->updateBatchContactsAsyncWithHttpInfo($updateBatchContacts) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateBatchContactsAsyncWithHttpInfo * * Update multiple contacts * * @param \Brevo\Client\Model\UpdateBatchContacts $updateBatchContacts Values to update multiple contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateBatchContactsAsyncWithHttpInfo($updateBatchContacts) { $returnType = ''; $request = $this->updateBatchContactsRequest($updateBatchContacts); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateBatchContacts' * * @param \Brevo\Client\Model\UpdateBatchContacts $updateBatchContacts Values to update multiple contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateBatchContactsRequest($updateBatchContacts) { // verify the required parameter 'updateBatchContacts' is set if ($updateBatchContacts === null || (is_array($updateBatchContacts) && count($updateBatchContacts) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateBatchContacts when calling updateBatchContacts' ); } $resourcePath = '/contacts/batch'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($updateBatchContacts)) { $_tempBody = $updateBatchContacts; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateContact * * Update a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param \Brevo\Client\Model\UpdateContact $updateContact Values to update a contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateContact($identifier, $updateContact) { $this->updateContactWithHttpInfo($identifier, $updateContact); } /** * Operation updateContactWithHttpInfo * * Update a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param \Brevo\Client\Model\UpdateContact $updateContact Values to update a contact (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateContactWithHttpInfo($identifier, $updateContact) { $returnType = ''; $request = $this->updateContactRequest($identifier, $updateContact); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateContactAsync * * Update a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param \Brevo\Client\Model\UpdateContact $updateContact Values to update a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateContactAsync($identifier, $updateContact) { return $this->updateContactAsyncWithHttpInfo($identifier, $updateContact) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateContactAsyncWithHttpInfo * * Update a contact * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param \Brevo\Client\Model\UpdateContact $updateContact Values to update a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateContactAsyncWithHttpInfo($identifier, $updateContact) { $returnType = ''; $request = $this->updateContactRequest($identifier, $updateContact); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateContact' * * @param string $identifier Email (urlencoded) OR ID of the contact (required) * @param \Brevo\Client\Model\UpdateContact $updateContact Values to update a contact (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateContactRequest($identifier, $updateContact) { // verify the required parameter 'identifier' is set if ($identifier === null || (is_array($identifier) && count($identifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $identifier when calling updateContact' ); } // verify the required parameter 'updateContact' is set if ($updateContact === null || (is_array($updateContact) && count($updateContact) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateContact when calling updateContact' ); } $resourcePath = '/contacts/{identifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($identifier !== null) { $resourcePath = str_replace( '{' . 'identifier' . '}', ObjectSerializer::toPathValue($identifier), $resourcePath ); } // body params $_tempBody = null; if (isset($updateContact)) { $_tempBody = $updateContact; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateFolder * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateFolder($folderId, $updateFolder) { $this->updateFolderWithHttpInfo($folderId, $updateFolder); } /** * Operation updateFolderWithHttpInfo * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateFolderWithHttpInfo($folderId, $updateFolder) { $returnType = ''; $request = $this->updateFolderRequest($folderId, $updateFolder); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateFolderAsync * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateFolderAsync($folderId, $updateFolder) { return $this->updateFolderAsyncWithHttpInfo($folderId, $updateFolder) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateFolderAsyncWithHttpInfo * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateFolderAsyncWithHttpInfo($folderId, $updateFolder) { $returnType = ''; $request = $this->updateFolderRequest($folderId, $updateFolder); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateFolder' * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateFolderRequest($folderId, $updateFolder) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling updateFolder' ); } // verify the required parameter 'updateFolder' is set if ($updateFolder === null || (is_array($updateFolder) && count($updateFolder) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateFolder when calling updateFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateFolder)) { $_tempBody = $updateFolder; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateList * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateList($listId, $updateList) { $this->updateListWithHttpInfo($listId, $updateList); } /** * Operation updateListWithHttpInfo * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateListWithHttpInfo($listId, $updateList) { $returnType = ''; $request = $this->updateListRequest($listId, $updateList); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateListAsync * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateListAsync($listId, $updateList) { return $this->updateListAsyncWithHttpInfo($listId, $updateList) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateListAsyncWithHttpInfo * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateListAsyncWithHttpInfo($listId, $updateList) { $returnType = ''; $request = $this->updateListRequest($listId, $updateList); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateListRequest($listId, $updateList) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling updateList' ); } // verify the required parameter 'updateList' is set if ($updateList === null || (is_array($updateList) && count($updateList) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateList when calling updateList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateList)) { $_tempBody = $updateList; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ConversationsApi.php 0000644 00000263255 15021222673 0013742 0 ustar 00 <?php /** * ConversationsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ConversationsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation conversationsAgentOnlinePingPost * * Sets agent’s status to online for 2-3 minutes * * @param \Brevo\Client\Model\Body12 $body Agent fields. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function conversationsAgentOnlinePingPost($body) { $this->conversationsAgentOnlinePingPostWithHttpInfo($body); } /** * Operation conversationsAgentOnlinePingPostWithHttpInfo * * Sets agent’s status to online for 2-3 minutes * * @param \Brevo\Client\Model\Body12 $body Agent fields. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function conversationsAgentOnlinePingPostWithHttpInfo($body) { $returnType = ''; $request = $this->conversationsAgentOnlinePingPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsAgentOnlinePingPostAsync * * Sets agent’s status to online for 2-3 minutes * * @param \Brevo\Client\Model\Body12 $body Agent fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsAgentOnlinePingPostAsync($body) { return $this->conversationsAgentOnlinePingPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsAgentOnlinePingPostAsyncWithHttpInfo * * Sets agent’s status to online for 2-3 minutes * * @param \Brevo\Client\Model\Body12 $body Agent fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsAgentOnlinePingPostAsyncWithHttpInfo($body) { $returnType = ''; $request = $this->conversationsAgentOnlinePingPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsAgentOnlinePingPost' * * @param \Brevo\Client\Model\Body12 $body Agent fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsAgentOnlinePingPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling conversationsAgentOnlinePingPost' ); } $resourcePath = '/conversations/agentOnlinePing'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsMessagesIdDelete * * Delete a message sent by an agent * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function conversationsMessagesIdDelete($id) { $this->conversationsMessagesIdDeleteWithHttpInfo($id); } /** * Operation conversationsMessagesIdDeleteWithHttpInfo * * Delete a message sent by an agent * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function conversationsMessagesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->conversationsMessagesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsMessagesIdDeleteAsync * * Delete a message sent by an agent * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdDeleteAsync($id) { return $this->conversationsMessagesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsMessagesIdDeleteAsyncWithHttpInfo * * Delete a message sent by an agent * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->conversationsMessagesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsMessagesIdDelete' * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsMessagesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsMessagesIdDelete' ); } $resourcePath = '/conversations/messages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsMessagesIdGet * * Get a message * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsMessagesIdGet($id) { list($response) = $this->conversationsMessagesIdGetWithHttpInfo($id); return $response; } /** * Operation conversationsMessagesIdGetWithHttpInfo * * Get a message * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsMessagesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsMessagesIdGetAsync * * Get a message * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdGetAsync($id) { return $this->conversationsMessagesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsMessagesIdGetAsyncWithHttpInfo * * Get a message * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsMessagesIdGet' * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsMessagesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsMessagesIdGet' ); } $resourcePath = '/conversations/messages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsMessagesIdPut * * Update a message sent by an agent * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body9 $body body (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsMessagesIdPut($id, $body = null) { list($response) = $this->conversationsMessagesIdPutWithHttpInfo($id, $body); return $response; } /** * Operation conversationsMessagesIdPutWithHttpInfo * * Update a message sent by an agent * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body9 $body (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsMessagesIdPutWithHttpInfo($id, $body = null) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesIdPutRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsMessagesIdPutAsync * * Update a message sent by an agent * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body9 $body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdPutAsync($id, $body = null) { return $this->conversationsMessagesIdPutAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsMessagesIdPutAsyncWithHttpInfo * * Update a message sent by an agent * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body9 $body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesIdPutAsyncWithHttpInfo($id, $body = null) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesIdPutRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsMessagesIdPut' * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body9 $body (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsMessagesIdPutRequest($id, $body = null) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsMessagesIdPut' ); } $resourcePath = '/conversations/messages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsMessagesPost * * Send a message as an agent * * @param \Brevo\Client\Model\Body8 $body Message fields. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsMessagesPost($body) { list($response) = $this->conversationsMessagesPostWithHttpInfo($body); return $response; } /** * Operation conversationsMessagesPostWithHttpInfo * * Send a message as an agent * * @param \Brevo\Client\Model\Body8 $body Message fields. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsMessagesPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsMessagesPostAsync * * Send a message as an agent * * @param \Brevo\Client\Model\Body8 $body Message fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesPostAsync($body) { return $this->conversationsMessagesPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsMessagesPostAsyncWithHttpInfo * * Send a message as an agent * * @param \Brevo\Client\Model\Body8 $body Message fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsMessagesPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsMessagesPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsMessagesPost' * * @param \Brevo\Client\Model\Body8 $body Message fields. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsMessagesPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling conversationsMessagesPost' ); } $resourcePath = '/conversations/messages'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsPushedMessagesIdDelete * * Delete an automated message * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function conversationsPushedMessagesIdDelete($id) { $this->conversationsPushedMessagesIdDeleteWithHttpInfo($id); } /** * Operation conversationsPushedMessagesIdDeleteWithHttpInfo * * Delete an automated message * * @param string $id ID of the message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function conversationsPushedMessagesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->conversationsPushedMessagesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsPushedMessagesIdDeleteAsync * * Delete an automated message * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdDeleteAsync($id) { return $this->conversationsPushedMessagesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsPushedMessagesIdDeleteAsyncWithHttpInfo * * Delete an automated message * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->conversationsPushedMessagesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsPushedMessagesIdDelete' * * @param string $id ID of the message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsPushedMessagesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsPushedMessagesIdDelete' ); } $resourcePath = '/conversations/pushedMessages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsPushedMessagesIdGet * * Get an automated message * * @param string $id ID of the message sent previously (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsPushedMessagesIdGet($id) { list($response) = $this->conversationsPushedMessagesIdGetWithHttpInfo($id); return $response; } /** * Operation conversationsPushedMessagesIdGetWithHttpInfo * * Get an automated message * * @param string $id ID of the message sent previously (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsPushedMessagesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsPushedMessagesIdGetAsync * * Get an automated message * * @param string $id ID of the message sent previously (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdGetAsync($id) { return $this->conversationsPushedMessagesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsPushedMessagesIdGetAsyncWithHttpInfo * * Get an automated message * * @param string $id ID of the message sent previously (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsPushedMessagesIdGet' * * @param string $id ID of the message sent previously (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsPushedMessagesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsPushedMessagesIdGet' ); } $resourcePath = '/conversations/pushedMessages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsPushedMessagesIdPut * * Update an automated message * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body11 $body body (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsPushedMessagesIdPut($id, $body) { list($response) = $this->conversationsPushedMessagesIdPutWithHttpInfo($id, $body); return $response; } /** * Operation conversationsPushedMessagesIdPutWithHttpInfo * * Update an automated message * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body11 $body (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsPushedMessagesIdPutWithHttpInfo($id, $body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesIdPutRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsPushedMessagesIdPutAsync * * Update an automated message * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body11 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdPutAsync($id, $body) { return $this->conversationsPushedMessagesIdPutAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsPushedMessagesIdPutAsyncWithHttpInfo * * Update an automated message * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body11 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesIdPutAsyncWithHttpInfo($id, $body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesIdPutRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsPushedMessagesIdPut' * * @param string $id ID of the message (required) * @param \Brevo\Client\Model\Body11 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsPushedMessagesIdPutRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling conversationsPushedMessagesIdPut' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling conversationsPushedMessagesIdPut' ); } $resourcePath = '/conversations/pushedMessages/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation conversationsPushedMessagesPost * * Send an automated message to a visitor * * @param \Brevo\Client\Model\Body10 $body body (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\ConversationsMessage */ public function conversationsPushedMessagesPost($body) { list($response) = $this->conversationsPushedMessagesPostWithHttpInfo($body); return $response; } /** * Operation conversationsPushedMessagesPostWithHttpInfo * * Send an automated message to a visitor * * @param \Brevo\Client\Model\Body10 $body (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\ConversationsMessage, HTTP status code, HTTP response headers (array of strings) */ public function conversationsPushedMessagesPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ConversationsMessage', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation conversationsPushedMessagesPostAsync * * Send an automated message to a visitor * * @param \Brevo\Client\Model\Body10 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesPostAsync($body) { return $this->conversationsPushedMessagesPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation conversationsPushedMessagesPostAsyncWithHttpInfo * * Send an automated message to a visitor * * @param \Brevo\Client\Model\Body10 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function conversationsPushedMessagesPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\ConversationsMessage'; $request = $this->conversationsPushedMessagesPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'conversationsPushedMessagesPost' * * @param \Brevo\Client\Model\Body10 $body (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function conversationsPushedMessagesPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling conversationsPushedMessagesPost' ); } $resourcePath = '/conversations/pushedMessages'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/InboundParsingApi.php 0000644 00000115247 15021222673 0014024 0 ustar 00 <?php /** * InboundParsingApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * InboundParsingApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InboundParsingApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getInboundEmailAttachment * * Retrieve inbound attachment with download token. * * @param string $downloadToken Token to fetch a particular attachment (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \SplFileObject */ public function getInboundEmailAttachment($downloadToken) { list($response) = $this->getInboundEmailAttachmentWithHttpInfo($downloadToken); return $response; } /** * Operation getInboundEmailAttachmentWithHttpInfo * * Retrieve inbound attachment with download token. * * @param string $downloadToken Token to fetch a particular attachment (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings) */ public function getInboundEmailAttachmentWithHttpInfo($downloadToken) { $returnType = '\SplFileObject'; $request = $this->getInboundEmailAttachmentRequest($downloadToken); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\SplFileObject', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getInboundEmailAttachmentAsync * * Retrieve inbound attachment with download token. * * @param string $downloadToken Token to fetch a particular attachment (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailAttachmentAsync($downloadToken) { return $this->getInboundEmailAttachmentAsyncWithHttpInfo($downloadToken) ->then( function ($response) { return $response[0]; } ); } /** * Operation getInboundEmailAttachmentAsyncWithHttpInfo * * Retrieve inbound attachment with download token. * * @param string $downloadToken Token to fetch a particular attachment (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailAttachmentAsyncWithHttpInfo($downloadToken) { $returnType = '\SplFileObject'; $request = $this->getInboundEmailAttachmentRequest($downloadToken); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getInboundEmailAttachment' * * @param string $downloadToken Token to fetch a particular attachment (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getInboundEmailAttachmentRequest($downloadToken) { // verify the required parameter 'downloadToken' is set if ($downloadToken === null || (is_array($downloadToken) && count($downloadToken) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $downloadToken when calling getInboundEmailAttachment' ); } $resourcePath = '/inbound/attachments/{downloadToken}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($downloadToken !== null) { $resourcePath = str_replace( '{' . 'downloadToken' . '}', ObjectSerializer::toPathValue($downloadToken), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getInboundEmailEvents * * Get the list of all the events for the received emails. * * @param string $sender Email address of the sender. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetInboundEmailEvents */ public function getInboundEmailEvents($sender = null, $startDate = null, $endDate = null, $limit = '100', $offset = '0', $sort = 'desc') { list($response) = $this->getInboundEmailEventsWithHttpInfo($sender, $startDate, $endDate, $limit, $offset, $sort); return $response; } /** * Operation getInboundEmailEventsWithHttpInfo * * Get the list of all the events for the received emails. * * @param string $sender Email address of the sender. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetInboundEmailEvents, HTTP status code, HTTP response headers (array of strings) */ public function getInboundEmailEventsWithHttpInfo($sender = null, $startDate = null, $endDate = null, $limit = '100', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetInboundEmailEvents'; $request = $this->getInboundEmailEventsRequest($sender, $startDate, $endDate, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetInboundEmailEvents', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getInboundEmailEventsAsync * * Get the list of all the events for the received emails. * * @param string $sender Email address of the sender. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailEventsAsync($sender = null, $startDate = null, $endDate = null, $limit = '100', $offset = '0', $sort = 'desc') { return $this->getInboundEmailEventsAsyncWithHttpInfo($sender, $startDate, $endDate, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getInboundEmailEventsAsyncWithHttpInfo * * Get the list of all the events for the received emails. * * @param string $sender Email address of the sender. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailEventsAsyncWithHttpInfo($sender = null, $startDate = null, $endDate = null, $limit = '100', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetInboundEmailEvents'; $request = $this->getInboundEmailEventsRequest($sender, $startDate, $endDate, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getInboundEmailEvents' * * @param string $sender Email address of the sender. (optional) * @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents returned per page (optional, default to 100) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getInboundEmailEventsRequest($sender = null, $startDate = null, $endDate = null, $limit = '100', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 500) { throw new \InvalidArgumentException('invalid value for "$limit" when calling InboundParsingApi.getInboundEmailEvents, must be smaller than or equal to 500.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling InboundParsingApi.getInboundEmailEvents, must be bigger than or equal to 0.'); } $resourcePath = '/inbound/events'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($sender !== null) { $queryParams['sender'] = ObjectSerializer::toQueryValue($sender); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getInboundEmailEventsByUuid * * Fetch all events history for one particular received email. * * @param string $uuid UUID to fetch events specific to recieved email (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetInboundEmailEventsByUuid */ public function getInboundEmailEventsByUuid($uuid) { list($response) = $this->getInboundEmailEventsByUuidWithHttpInfo($uuid); return $response; } /** * Operation getInboundEmailEventsByUuidWithHttpInfo * * Fetch all events history for one particular received email. * * @param string $uuid UUID to fetch events specific to recieved email (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetInboundEmailEventsByUuid, HTTP status code, HTTP response headers (array of strings) */ public function getInboundEmailEventsByUuidWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetInboundEmailEventsByUuid'; $request = $this->getInboundEmailEventsByUuidRequest($uuid); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetInboundEmailEventsByUuid', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getInboundEmailEventsByUuidAsync * * Fetch all events history for one particular received email. * * @param string $uuid UUID to fetch events specific to recieved email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailEventsByUuidAsync($uuid) { return $this->getInboundEmailEventsByUuidAsyncWithHttpInfo($uuid) ->then( function ($response) { return $response[0]; } ); } /** * Operation getInboundEmailEventsByUuidAsyncWithHttpInfo * * Fetch all events history for one particular received email. * * @param string $uuid UUID to fetch events specific to recieved email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInboundEmailEventsByUuidAsyncWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetInboundEmailEventsByUuid'; $request = $this->getInboundEmailEventsByUuidRequest($uuid); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getInboundEmailEventsByUuid' * * @param string $uuid UUID to fetch events specific to recieved email (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getInboundEmailEventsByUuidRequest($uuid) { // verify the required parameter 'uuid' is set if ($uuid === null || (is_array($uuid) && count($uuid) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uuid when calling getInboundEmailEventsByUuid' ); } $resourcePath = '/inbound/events/{uuid}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($uuid !== null) { $resourcePath = str_replace( '{' . 'uuid' . '}', ObjectSerializer::toPathValue($uuid), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/UserApi.php 0000644 00000053414 15021222673 0012015 0 ustar 00 <?php /** * UserApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * UserApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UserApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getInvitedUsersList * * Get the list of all your users * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetInvitedUsersList */ public function getInvitedUsersList() { list($response) = $this->getInvitedUsersListWithHttpInfo(); return $response; } /** * Operation getInvitedUsersListWithHttpInfo * * Get the list of all your users * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetInvitedUsersList, HTTP status code, HTTP response headers (array of strings) */ public function getInvitedUsersListWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetInvitedUsersList'; $request = $this->getInvitedUsersListRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetInvitedUsersList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getInvitedUsersListAsync * * Get the list of all your users * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInvitedUsersListAsync() { return $this->getInvitedUsersListAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getInvitedUsersListAsyncWithHttpInfo * * Get the list of all your users * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getInvitedUsersListAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetInvitedUsersList'; $request = $this->getInvitedUsersListRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getInvitedUsersList' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getInvitedUsersListRequest() { $resourcePath = '/organization/invited/users'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getUserPermission * * Check user permission * * @param string $email Email of the invited user. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetUserPermission */ public function getUserPermission($email) { list($response) = $this->getUserPermissionWithHttpInfo($email); return $response; } /** * Operation getUserPermissionWithHttpInfo * * Check user permission * * @param string $email Email of the invited user. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetUserPermission, HTTP status code, HTTP response headers (array of strings) */ public function getUserPermissionWithHttpInfo($email) { $returnType = '\Brevo\Client\Model\GetUserPermission'; $request = $this->getUserPermissionRequest($email); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetUserPermission', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getUserPermissionAsync * * Check user permission * * @param string $email Email of the invited user. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getUserPermissionAsync($email) { return $this->getUserPermissionAsyncWithHttpInfo($email) ->then( function ($response) { return $response[0]; } ); } /** * Operation getUserPermissionAsyncWithHttpInfo * * Check user permission * * @param string $email Email of the invited user. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getUserPermissionAsyncWithHttpInfo($email) { $returnType = '\Brevo\Client\Model\GetUserPermission'; $request = $this->getUserPermissionRequest($email); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getUserPermission' * * @param string $email Email of the invited user. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getUserPermissionRequest($email) { // verify the required parameter 'email' is set if ($email === null || (is_array($email) && count($email) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $email when calling getUserPermission' ); } $resourcePath = '/organization/user/{email}/permissions'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($email !== null) { $resourcePath = str_replace( '{' . 'email' . '}', ObjectSerializer::toPathValue($email), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/CRMApi.php 0000644 00000347413 15021222673 0011525 0 ustar 00 <?php /** * CRMApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * CRMApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CRMApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation crmNotesGet * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\NoteList */ public function crmNotesGet($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { list($response) = $this->crmNotesGetWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $response; } /** * Operation crmNotesGetWithHttpInfo * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\NoteList, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesGetWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\NoteList'; $request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\NoteList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesGetAsync * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesGetAsync($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { return $this->crmNotesGetAsyncWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesGetAsyncWithHttpInfo * * Get all notes * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesGetAsyncWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\NoteList'; $request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesGet' * * @param string $entity Filter by note entity type (optional) * @param string $entityIds Filter by note entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesGetRequest($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $resourcePath = '/crm/notes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($entity !== null) { $queryParams['entity'] = ObjectSerializer::toQueryValue($entity); } // query params if ($entityIds !== null) { $queryParams['entityIds'] = ObjectSerializer::toQueryValue($entityIds); } // query params if ($dateFrom !== null) { $queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom); } // query params if ($dateTo !== null) { $queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdDelete * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmNotesIdDelete($id) { $this->crmNotesIdDeleteWithHttpInfo($id); } /** * Operation crmNotesIdDeleteWithHttpInfo * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmNotesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdDeleteAsync * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdDeleteAsync($id) { return $this->crmNotesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdDeleteAsyncWithHttpInfo * * Delete a note * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmNotesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdDelete' * * @param string $id Note ID to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdDelete' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdGet * * Get a note * * @param string $id Note ID to get (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Note */ public function crmNotesIdGet($id) { list($response) = $this->crmNotesIdGetWithHttpInfo($id); return $response; } /** * Operation crmNotesIdGetWithHttpInfo * * Get a note * * @param string $id Note ID to get (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Note, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Note'; $request = $this->crmNotesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Note', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdGetAsync * * Get a note * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdGetAsync($id) { return $this->crmNotesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdGetAsyncWithHttpInfo * * Get a note * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Note'; $request = $this->crmNotesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdGet' * * @param string $id Note ID to get (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdGet' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesIdPatch * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmNotesIdPatch($id, $body) { $this->crmNotesIdPatchWithHttpInfo($id, $body); } /** * Operation crmNotesIdPatchWithHttpInfo * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmNotesIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 415: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesIdPatchAsync * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdPatchAsync($id, $body) { return $this->crmNotesIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesIdPatchAsyncWithHttpInfo * * Update a note * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmNotesIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesIdPatch' * * @param string $id Note ID to update (required) * @param \Brevo\Client\Model\NoteData $body Note data to update a note (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmNotesIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmNotesIdPatch' ); } $resourcePath = '/crm/notes/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmNotesPost * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\NoteId */ public function crmNotesPost($body) { list($response) = $this->crmNotesPostWithHttpInfo($body); return $response; } /** * Operation crmNotesPostWithHttpInfo * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\NoteId, HTTP status code, HTTP response headers (array of strings) */ public function crmNotesPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\NoteId'; $request = $this->crmNotesPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\NoteId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 415: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmNotesPostAsync * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesPostAsync($body) { return $this->crmNotesPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmNotesPostAsyncWithHttpInfo * * Create a note * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmNotesPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\NoteId'; $request = $this->crmNotesPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmNotesPost' * * @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmNotesPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmNotesPost' ); } $resourcePath = '/crm/notes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksGet * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\TaskList */ public function crmTasksGet($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { list($response) = $this->crmTasksGetWithHttpInfo($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); return $response; } /** * Operation crmTasksGetWithHttpInfo * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\TaskList, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksGetWithHttpInfo($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\TaskList'; $request = $this->crmTasksGetRequest($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\TaskList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksGetAsync * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksGetAsync($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { return $this->crmTasksGetAsyncWithHttpInfo($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksGetAsyncWithHttpInfo * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksGetAsyncWithHttpInfo($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\TaskList'; $request = $this->crmTasksGetRequest($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksGet' * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksGetRequest($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $resourcePath = '/crm/tasks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($filterType !== null) { $queryParams['filter[type]'] = ObjectSerializer::toQueryValue($filterType); } // query params if ($filterStatus !== null) { $queryParams['filter[status]'] = ObjectSerializer::toQueryValue($filterStatus); } // query params if ($filterDate !== null) { $queryParams['filter[date]'] = ObjectSerializer::toQueryValue($filterDate); } // query params if ($filterAssignTo !== null) { $queryParams['filter[assignTo]'] = ObjectSerializer::toQueryValue($filterAssignTo); } // query params if ($filterContacts !== null) { $queryParams['filter[contacts]'] = ObjectSerializer::toQueryValue($filterContacts); } // query params if ($filterDeals !== null) { $queryParams['filter[deals]'] = ObjectSerializer::toQueryValue($filterDeals); } // query params if ($filterCompanies !== null) { $queryParams['filter[companies]'] = ObjectSerializer::toQueryValue($filterCompanies); } // query params if ($dateFrom !== null) { $queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom); } // query params if ($dateTo !== null) { $queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($sortBy !== null) { $queryParams['sortBy'] = ObjectSerializer::toQueryValue($sortBy); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdDelete * * Delete a task * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmTasksIdDelete($id) { $this->crmTasksIdDeleteWithHttpInfo($id); } /** * Operation crmTasksIdDeleteWithHttpInfo * * Delete a task * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmTasksIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdDeleteAsync * * Delete a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdDeleteAsync($id) { return $this->crmTasksIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdDeleteAsyncWithHttpInfo * * Delete a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmTasksIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdDelete' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdDelete' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdGet * * Get a task * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Task */ public function crmTasksIdGet($id) { list($response) = $this->crmTasksIdGetWithHttpInfo($id); return $response; } /** * Operation crmTasksIdGetWithHttpInfo * * Get a task * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Task, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Task'; $request = $this->crmTasksIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Task', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdGetAsync * * Get a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdGetAsync($id) { return $this->crmTasksIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdGetAsyncWithHttpInfo * * Get a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Task'; $request = $this->crmTasksIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdGet' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdGet' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdPatch * * Update a task * * @param string $id id (required) * @param \Brevo\Client\Model\Body1 $body Updated task details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmTasksIdPatch($id, $body) { $this->crmTasksIdPatchWithHttpInfo($id, $body); } /** * Operation crmTasksIdPatchWithHttpInfo * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated task details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmTasksIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdPatchAsync * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdPatchAsync($id, $body) { return $this->crmTasksIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdPatchAsyncWithHttpInfo * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmTasksIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmTasksIdPatch' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksPost * * Create a task * * @param \Brevo\Client\Model\Body $body Task name. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse201 */ public function crmTasksPost($body) { list($response) = $this->crmTasksPostWithHttpInfo($body); return $response; } /** * Operation crmTasksPostWithHttpInfo * * Create a task * * @param \Brevo\Client\Model\Body $body Task name. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse201, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse201'; $request = $this->crmTasksPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse201', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksPostAsync * * Create a task * * @param \Brevo\Client\Model\Body $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksPostAsync($body) { return $this->crmTasksPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksPostAsyncWithHttpInfo * * Create a task * * @param \Brevo\Client\Model\Body $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse201'; $request = $this->crmTasksPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksPost' * * @param \Brevo\Client\Model\Body $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmTasksPost' ); } $resourcePath = '/crm/tasks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasktypesGet * * Get all task types * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\TaskTypes */ public function crmTasktypesGet() { list($response) = $this->crmTasktypesGetWithHttpInfo(); return $response; } /** * Operation crmTasktypesGetWithHttpInfo * * Get all task types * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\TaskTypes, HTTP status code, HTTP response headers (array of strings) */ public function crmTasktypesGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\TaskTypes'; $request = $this->crmTasktypesGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\TaskTypes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasktypesGetAsync * * Get all task types * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasktypesGetAsync() { return $this->crmTasktypesGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasktypesGetAsyncWithHttpInfo * * Get all task types * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasktypesGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\TaskTypes'; $request = $this->crmTasktypesGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasktypesGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasktypesGetRequest() { $resourcePath = '/crm/tasktypes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/MasterAccountApi.php 0000644 00000322106 15021222673 0013644 0 ustar 00 <?php /** * MasterAccountApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * MasterAccountApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterAccountApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation corporateMasterAccountGet * * Get the details of requested master account * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\MasterDetailsResponse */ public function corporateMasterAccountGet() { list($response) = $this->corporateMasterAccountGetWithHttpInfo(); return $response; } /** * Operation corporateMasterAccountGetWithHttpInfo * * Get the details of requested master account * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\MasterDetailsResponse, HTTP status code, HTTP response headers (array of strings) */ public function corporateMasterAccountGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\MasterDetailsResponse'; $request = $this->corporateMasterAccountGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\MasterDetailsResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateMasterAccountGetAsync * * Get the details of requested master account * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateMasterAccountGetAsync() { return $this->corporateMasterAccountGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateMasterAccountGetAsyncWithHttpInfo * * Get the details of requested master account * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateMasterAccountGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\MasterDetailsResponse'; $request = $this->corporateMasterAccountGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateMasterAccountGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateMasterAccountGetRequest() { $resourcePath = '/corporate/masterAccount'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountGet * * Get the list of all the sub-accounts of the master account. * * @param int $offset Index of the first sub-account in the page (required) * @param int $limit Number of sub-accounts to be displayed on each page (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\SubAccountsResponse */ public function corporateSubAccountGet($offset, $limit) { list($response) = $this->corporateSubAccountGetWithHttpInfo($offset, $limit); return $response; } /** * Operation corporateSubAccountGetWithHttpInfo * * Get the list of all the sub-accounts of the master account. * * @param int $offset Index of the first sub-account in the page (required) * @param int $limit Number of sub-accounts to be displayed on each page (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\SubAccountsResponse, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountGetWithHttpInfo($offset, $limit) { $returnType = '\Brevo\Client\Model\SubAccountsResponse'; $request = $this->corporateSubAccountGetRequest($offset, $limit); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\SubAccountsResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountGetAsync * * Get the list of all the sub-accounts of the master account. * * @param int $offset Index of the first sub-account in the page (required) * @param int $limit Number of sub-accounts to be displayed on each page (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountGetAsync($offset, $limit) { return $this->corporateSubAccountGetAsyncWithHttpInfo($offset, $limit) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountGetAsyncWithHttpInfo * * Get the list of all the sub-accounts of the master account. * * @param int $offset Index of the first sub-account in the page (required) * @param int $limit Number of sub-accounts to be displayed on each page (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountGetAsyncWithHttpInfo($offset, $limit) { $returnType = '\Brevo\Client\Model\SubAccountsResponse'; $request = $this->corporateSubAccountGetRequest($offset, $limit); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountGet' * * @param int $offset Index of the first sub-account in the page (required) * @param int $limit Number of sub-accounts to be displayed on each page (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountGetRequest($offset, $limit) { // verify the required parameter 'offset' is set if ($offset === null || (is_array($offset) && count($offset) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $offset when calling corporateSubAccountGet' ); } // verify the required parameter 'limit' is set if ($limit === null || (is_array($limit) && count($limit) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $limit when calling corporateSubAccountGet' ); } $resourcePath = '/corporate/subAccount'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountIdApplicationsTogglePut * * Enable/disable sub-account application(s) * * @param int $id Id of the sub-account organization (mandatory) (required) * @param \Brevo\Client\Model\SubAccountAppsToggleRequest $toggleApplications List of applications to activate or deactivate on a sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function corporateSubAccountIdApplicationsTogglePut($id, $toggleApplications) { $this->corporateSubAccountIdApplicationsTogglePutWithHttpInfo($id, $toggleApplications); } /** * Operation corporateSubAccountIdApplicationsTogglePutWithHttpInfo * * Enable/disable sub-account application(s) * * @param int $id Id of the sub-account organization (mandatory) (required) * @param \Brevo\Client\Model\SubAccountAppsToggleRequest $toggleApplications List of applications to activate or deactivate on a sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountIdApplicationsTogglePutWithHttpInfo($id, $toggleApplications) { $returnType = ''; $request = $this->corporateSubAccountIdApplicationsTogglePutRequest($id, $toggleApplications); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountIdApplicationsTogglePutAsync * * Enable/disable sub-account application(s) * * @param int $id Id of the sub-account organization (mandatory) (required) * @param \Brevo\Client\Model\SubAccountAppsToggleRequest $toggleApplications List of applications to activate or deactivate on a sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdApplicationsTogglePutAsync($id, $toggleApplications) { return $this->corporateSubAccountIdApplicationsTogglePutAsyncWithHttpInfo($id, $toggleApplications) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountIdApplicationsTogglePutAsyncWithHttpInfo * * Enable/disable sub-account application(s) * * @param int $id Id of the sub-account organization (mandatory) (required) * @param \Brevo\Client\Model\SubAccountAppsToggleRequest $toggleApplications List of applications to activate or deactivate on a sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdApplicationsTogglePutAsyncWithHttpInfo($id, $toggleApplications) { $returnType = ''; $request = $this->corporateSubAccountIdApplicationsTogglePutRequest($id, $toggleApplications); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountIdApplicationsTogglePut' * * @param int $id Id of the sub-account organization (mandatory) (required) * @param \Brevo\Client\Model\SubAccountAppsToggleRequest $toggleApplications List of applications to activate or deactivate on a sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountIdApplicationsTogglePutRequest($id, $toggleApplications) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling corporateSubAccountIdApplicationsTogglePut' ); } // verify the required parameter 'toggleApplications' is set if ($toggleApplications === null || (is_array($toggleApplications) && count($toggleApplications) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $toggleApplications when calling corporateSubAccountIdApplicationsTogglePut' ); } $resourcePath = '/corporate/subAccount/{id}/applications/toggle'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($toggleApplications)) { $_tempBody = $toggleApplications; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountIdDelete * * Delete a sub-account * * @param int $id Id of the sub-account organization to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function corporateSubAccountIdDelete($id) { $this->corporateSubAccountIdDeleteWithHttpInfo($id); } /** * Operation corporateSubAccountIdDeleteWithHttpInfo * * Delete a sub-account * * @param int $id Id of the sub-account organization to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->corporateSubAccountIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { } throw $e; } } /** * Operation corporateSubAccountIdDeleteAsync * * Delete a sub-account * * @param int $id Id of the sub-account organization to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdDeleteAsync($id) { return $this->corporateSubAccountIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountIdDeleteAsyncWithHttpInfo * * Delete a sub-account * * @param int $id Id of the sub-account organization to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->corporateSubAccountIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountIdDelete' * * @param int $id Id of the sub-account organization to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling corporateSubAccountIdDelete' ); } $resourcePath = '/corporate/subAccount/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountIdGet * * Get sub-account details * * @param int $id Id of the sub-account organization (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\SubAccountDetailsResponse */ public function corporateSubAccountIdGet($id) { list($response) = $this->corporateSubAccountIdGetWithHttpInfo($id); return $response; } /** * Operation corporateSubAccountIdGetWithHttpInfo * * Get sub-account details * * @param int $id Id of the sub-account organization (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\SubAccountDetailsResponse, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\SubAccountDetailsResponse'; $request = $this->corporateSubAccountIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\SubAccountDetailsResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountIdGetAsync * * Get sub-account details * * @param int $id Id of the sub-account organization (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdGetAsync($id) { return $this->corporateSubAccountIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountIdGetAsyncWithHttpInfo * * Get sub-account details * * @param int $id Id of the sub-account organization (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\SubAccountDetailsResponse'; $request = $this->corporateSubAccountIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountIdGet' * * @param int $id Id of the sub-account organization (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling corporateSubAccountIdGet' ); } $resourcePath = '/corporate/subAccount/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountIdPlanPut * * Update sub-account plan * * @param int $id Id of the sub-account organization (required) * @param \Brevo\Client\Model\SubAccountUpdatePlanRequest $updatePlanDetails Values to update a sub-account plan (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function corporateSubAccountIdPlanPut($id, $updatePlanDetails) { $this->corporateSubAccountIdPlanPutWithHttpInfo($id, $updatePlanDetails); } /** * Operation corporateSubAccountIdPlanPutWithHttpInfo * * Update sub-account plan * * @param int $id Id of the sub-account organization (required) * @param \Brevo\Client\Model\SubAccountUpdatePlanRequest $updatePlanDetails Values to update a sub-account plan (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountIdPlanPutWithHttpInfo($id, $updatePlanDetails) { $returnType = ''; $request = $this->corporateSubAccountIdPlanPutRequest($id, $updatePlanDetails); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountIdPlanPutAsync * * Update sub-account plan * * @param int $id Id of the sub-account organization (required) * @param \Brevo\Client\Model\SubAccountUpdatePlanRequest $updatePlanDetails Values to update a sub-account plan (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdPlanPutAsync($id, $updatePlanDetails) { return $this->corporateSubAccountIdPlanPutAsyncWithHttpInfo($id, $updatePlanDetails) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountIdPlanPutAsyncWithHttpInfo * * Update sub-account plan * * @param int $id Id of the sub-account organization (required) * @param \Brevo\Client\Model\SubAccountUpdatePlanRequest $updatePlanDetails Values to update a sub-account plan (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountIdPlanPutAsyncWithHttpInfo($id, $updatePlanDetails) { $returnType = ''; $request = $this->corporateSubAccountIdPlanPutRequest($id, $updatePlanDetails); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountIdPlanPut' * * @param int $id Id of the sub-account organization (required) * @param \Brevo\Client\Model\SubAccountUpdatePlanRequest $updatePlanDetails Values to update a sub-account plan (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountIdPlanPutRequest($id, $updatePlanDetails) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling corporateSubAccountIdPlanPut' ); } // verify the required parameter 'updatePlanDetails' is set if ($updatePlanDetails === null || (is_array($updatePlanDetails) && count($updatePlanDetails) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updatePlanDetails when calling corporateSubAccountIdPlanPut' ); } $resourcePath = '/corporate/subAccount/{id}/plan'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($updatePlanDetails)) { $_tempBody = $updatePlanDetails; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountKeyPost * * Create an API key for a sub-account * * @param \Brevo\Client\Model\CreateApiKeyRequest $createApiKeyRequest Values to generate API key for sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateApiKeyResponse */ public function corporateSubAccountKeyPost($createApiKeyRequest) { list($response) = $this->corporateSubAccountKeyPostWithHttpInfo($createApiKeyRequest); return $response; } /** * Operation corporateSubAccountKeyPostWithHttpInfo * * Create an API key for a sub-account * * @param \Brevo\Client\Model\CreateApiKeyRequest $createApiKeyRequest Values to generate API key for sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateApiKeyResponse, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountKeyPostWithHttpInfo($createApiKeyRequest) { $returnType = '\Brevo\Client\Model\CreateApiKeyResponse'; $request = $this->corporateSubAccountKeyPostRequest($createApiKeyRequest); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateApiKeyResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountKeyPostAsync * * Create an API key for a sub-account * * @param \Brevo\Client\Model\CreateApiKeyRequest $createApiKeyRequest Values to generate API key for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountKeyPostAsync($createApiKeyRequest) { return $this->corporateSubAccountKeyPostAsyncWithHttpInfo($createApiKeyRequest) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountKeyPostAsyncWithHttpInfo * * Create an API key for a sub-account * * @param \Brevo\Client\Model\CreateApiKeyRequest $createApiKeyRequest Values to generate API key for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountKeyPostAsyncWithHttpInfo($createApiKeyRequest) { $returnType = '\Brevo\Client\Model\CreateApiKeyResponse'; $request = $this->corporateSubAccountKeyPostRequest($createApiKeyRequest); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountKeyPost' * * @param \Brevo\Client\Model\CreateApiKeyRequest $createApiKeyRequest Values to generate API key for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountKeyPostRequest($createApiKeyRequest) { // verify the required parameter 'createApiKeyRequest' is set if ($createApiKeyRequest === null || (is_array($createApiKeyRequest) && count($createApiKeyRequest) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createApiKeyRequest when calling corporateSubAccountKeyPost' ); } $resourcePath = '/corporate/subAccount/key'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createApiKeyRequest)) { $_tempBody = $createApiKeyRequest; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountPost * * Create a new sub-account under a master account. * * @param \Brevo\Client\Model\CreateSubAccount $subAccountCreate values to create new sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateSubAccountResponse */ public function corporateSubAccountPost($subAccountCreate) { list($response) = $this->corporateSubAccountPostWithHttpInfo($subAccountCreate); return $response; } /** * Operation corporateSubAccountPostWithHttpInfo * * Create a new sub-account under a master account. * * @param \Brevo\Client\Model\CreateSubAccount $subAccountCreate values to create new sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateSubAccountResponse, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountPostWithHttpInfo($subAccountCreate) { $returnType = '\Brevo\Client\Model\CreateSubAccountResponse'; $request = $this->corporateSubAccountPostRequest($subAccountCreate); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateSubAccountResponse', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountPostAsync * * Create a new sub-account under a master account. * * @param \Brevo\Client\Model\CreateSubAccount $subAccountCreate values to create new sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountPostAsync($subAccountCreate) { return $this->corporateSubAccountPostAsyncWithHttpInfo($subAccountCreate) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountPostAsyncWithHttpInfo * * Create a new sub-account under a master account. * * @param \Brevo\Client\Model\CreateSubAccount $subAccountCreate values to create new sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountPostAsyncWithHttpInfo($subAccountCreate) { $returnType = '\Brevo\Client\Model\CreateSubAccountResponse'; $request = $this->corporateSubAccountPostRequest($subAccountCreate); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountPost' * * @param \Brevo\Client\Model\CreateSubAccount $subAccountCreate values to create new sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountPostRequest($subAccountCreate) { // verify the required parameter 'subAccountCreate' is set if ($subAccountCreate === null || (is_array($subAccountCreate) && count($subAccountCreate) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $subAccountCreate when calling corporateSubAccountPost' ); } $resourcePath = '/corporate/subAccount'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($subAccountCreate)) { $_tempBody = $subAccountCreate; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation corporateSubAccountSsoTokenPost * * Generate SSO token to access Brevo * * @param \Brevo\Client\Model\SsoTokenRequest $ssoTokenRequest Values to generate SSO token for sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSsoToken */ public function corporateSubAccountSsoTokenPost($ssoTokenRequest) { list($response) = $this->corporateSubAccountSsoTokenPostWithHttpInfo($ssoTokenRequest); return $response; } /** * Operation corporateSubAccountSsoTokenPostWithHttpInfo * * Generate SSO token to access Brevo * * @param \Brevo\Client\Model\SsoTokenRequest $ssoTokenRequest Values to generate SSO token for sub-account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSsoToken, HTTP status code, HTTP response headers (array of strings) */ public function corporateSubAccountSsoTokenPostWithHttpInfo($ssoTokenRequest) { $returnType = '\Brevo\Client\Model\GetSsoToken'; $request = $this->corporateSubAccountSsoTokenPostRequest($ssoTokenRequest); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSsoToken', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation corporateSubAccountSsoTokenPostAsync * * Generate SSO token to access Brevo * * @param \Brevo\Client\Model\SsoTokenRequest $ssoTokenRequest Values to generate SSO token for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountSsoTokenPostAsync($ssoTokenRequest) { return $this->corporateSubAccountSsoTokenPostAsyncWithHttpInfo($ssoTokenRequest) ->then( function ($response) { return $response[0]; } ); } /** * Operation corporateSubAccountSsoTokenPostAsyncWithHttpInfo * * Generate SSO token to access Brevo * * @param \Brevo\Client\Model\SsoTokenRequest $ssoTokenRequest Values to generate SSO token for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function corporateSubAccountSsoTokenPostAsyncWithHttpInfo($ssoTokenRequest) { $returnType = '\Brevo\Client\Model\GetSsoToken'; $request = $this->corporateSubAccountSsoTokenPostRequest($ssoTokenRequest); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'corporateSubAccountSsoTokenPost' * * @param \Brevo\Client\Model\SsoTokenRequest $ssoTokenRequest Values to generate SSO token for sub-account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function corporateSubAccountSsoTokenPostRequest($ssoTokenRequest) { // verify the required parameter 'ssoTokenRequest' is set if ($ssoTokenRequest === null || (is_array($ssoTokenRequest) && count($ssoTokenRequest) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $ssoTokenRequest when calling corporateSubAccountSsoTokenPost' ); } $resourcePath = '/corporate/subAccount/ssoToken'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($ssoTokenRequest)) { $_tempBody = $ssoTokenRequest; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAccountActivity * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAccountActivity */ public function getAccountActivity($startDate = null, $endDate = null, $limit = '10', $offset = '0') { list($response) = $this->getAccountActivityWithHttpInfo($startDate, $endDate, $limit, $offset); return $response; } /** * Operation getAccountActivityWithHttpInfo * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAccountActivity, HTTP status code, HTTP response headers (array of strings) */ public function getAccountActivityWithHttpInfo($startDate = null, $endDate = null, $limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAccountActivity'; $request = $this->getAccountActivityRequest($startDate, $endDate, $limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAccountActivity', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAccountActivityAsync * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountActivityAsync($startDate = null, $endDate = null, $limit = '10', $offset = '0') { return $this->getAccountActivityAsyncWithHttpInfo($startDate, $endDate, $limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getAccountActivityAsyncWithHttpInfo * * Get user activity logs * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAccountActivityAsyncWithHttpInfo($startDate = null, $endDate = null, $limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAccountActivity'; $request = $this->getAccountActivityRequest($startDate, $endDate, $limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAccountActivity' * * @param string $startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search. (optional) * @param string $endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. (optional) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document in the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAccountActivityRequest($startDate = null, $endDate = null, $limit = '10', $offset = '0') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling MasterAccountApi.getAccountActivity, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 1) { throw new \InvalidArgumentException('invalid value for "$limit" when calling MasterAccountApi.getAccountActivity, must be bigger than or equal to 1.'); } $resourcePath = '/organization/activities'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/TransactionalWhatsAppApi.php 0000644 00000074231 15021222673 0015351 0 ustar 00 <?php /** * TransactionalWhatsAppApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * TransactionalWhatsAppApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalWhatsAppApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getWhatsappEventReport * * Get all your WhatsApp activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from (optional, default to 0) * @param string $startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ (optional) * @param string $contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWhatsappEventReport */ public function getWhatsappEventReport($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $contactNumber = null, $event = null, $sort = 'desc') { list($response) = $this->getWhatsappEventReportWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort); return $response; } /** * Operation getWhatsappEventReportWithHttpInfo * * Get all your WhatsApp activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from (optional, default to 0) * @param string $startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ (optional) * @param string $contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWhatsappEventReport, HTTP status code, HTTP response headers (array of strings) */ public function getWhatsappEventReportWithHttpInfo($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $contactNumber = null, $event = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWhatsappEventReport'; $request = $this->getWhatsappEventReportRequest($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWhatsappEventReport', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWhatsappEventReportAsync * * Get all your WhatsApp activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from (optional, default to 0) * @param string $startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ (optional) * @param string $contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsappEventReportAsync($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $contactNumber = null, $event = null, $sort = 'desc') { return $this->getWhatsappEventReportAsyncWithHttpInfo($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWhatsappEventReportAsyncWithHttpInfo * * Get all your WhatsApp activity (unaggregated events) * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from (optional, default to 0) * @param string $startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ (optional) * @param string $contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsappEventReportAsyncWithHttpInfo($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $contactNumber = null, $event = null, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWhatsappEventReport'; $request = $this->getWhatsappEventReportRequest($limit, $offset, $startDate, $endDate, $days, $contactNumber, $event, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWhatsappEventReport' * * @param int $limit Number limitation for the result returned (optional, default to 2500) * @param int $offset Beginning point in the list to retrieve from (optional, default to 0) * @param string $startDate **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional) * @param string $endDate **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional) * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ (optional) * @param string $contactNumber Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721) (optional) * @param string $event Filter the report for a specific event type (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWhatsappEventReportRequest($limit = '2500', $offset = '0', $startDate = null, $endDate = null, $days = null, $contactNumber = null, $event = null, $sort = 'desc') { if ($limit !== null && $limit > 5000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalWhatsAppApi.getWhatsappEventReport, must be smaller than or equal to 5000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalWhatsAppApi.getWhatsappEventReport, must be bigger than or equal to 0.'); } $resourcePath = '/whatsapp/statistics/events'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($days !== null) { $queryParams['days'] = ObjectSerializer::toQueryValue($days); } // query params if ($contactNumber !== null) { $queryParams['contactNumber'] = ObjectSerializer::toQueryValue($contactNumber); } // query params if ($event !== null) { $queryParams['event'] = ObjectSerializer::toQueryValue($event); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendWhatsappMessage * * Send a WhatsApp message * * @param \Brevo\Client\Model\SendWhatsappMessage $sendWhatsappMessage Values to send WhatsApp message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse2013 */ public function sendWhatsappMessage($sendWhatsappMessage) { list($response) = $this->sendWhatsappMessageWithHttpInfo($sendWhatsappMessage); return $response; } /** * Operation sendWhatsappMessageWithHttpInfo * * Send a WhatsApp message * * @param \Brevo\Client\Model\SendWhatsappMessage $sendWhatsappMessage Values to send WhatsApp message (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse2013, HTTP status code, HTTP response headers (array of strings) */ public function sendWhatsappMessageWithHttpInfo($sendWhatsappMessage) { $returnType = '\Brevo\Client\Model\InlineResponse2013'; $request = $this->sendWhatsappMessageRequest($sendWhatsappMessage); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse2013', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendWhatsappMessageAsync * * Send a WhatsApp message * * @param \Brevo\Client\Model\SendWhatsappMessage $sendWhatsappMessage Values to send WhatsApp message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendWhatsappMessageAsync($sendWhatsappMessage) { return $this->sendWhatsappMessageAsyncWithHttpInfo($sendWhatsappMessage) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendWhatsappMessageAsyncWithHttpInfo * * Send a WhatsApp message * * @param \Brevo\Client\Model\SendWhatsappMessage $sendWhatsappMessage Values to send WhatsApp message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendWhatsappMessageAsyncWithHttpInfo($sendWhatsappMessage) { $returnType = '\Brevo\Client\Model\InlineResponse2013'; $request = $this->sendWhatsappMessageRequest($sendWhatsappMessage); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendWhatsappMessage' * * @param \Brevo\Client\Model\SendWhatsappMessage $sendWhatsappMessage Values to send WhatsApp message (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendWhatsappMessageRequest($sendWhatsappMessage) { // verify the required parameter 'sendWhatsappMessage' is set if ($sendWhatsappMessage === null || (is_array($sendWhatsappMessage) && count($sendWhatsappMessage) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendWhatsappMessage when calling sendWhatsappMessage' ); } $resourcePath = '/whatsapp/sendMessage'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($sendWhatsappMessage)) { $_tempBody = $sendWhatsappMessage; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/TasksApi.php 0000644 00000202076 15021222673 0012164 0 ustar 00 <?php /** * TasksApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * TasksApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TasksApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation crmTasksGet * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\TaskList */ public function crmTasksGet($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { list($response) = $this->crmTasksGetWithHttpInfo($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); return $response; } /** * Operation crmTasksGetWithHttpInfo * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\TaskList, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksGetWithHttpInfo($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\TaskList'; $request = $this->crmTasksGetRequest($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\TaskList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksGetAsync * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksGetAsync($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { return $this->crmTasksGetAsyncWithHttpInfo($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksGetAsyncWithHttpInfo * * Get all tasks * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksGetAsyncWithHttpInfo($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\TaskList'; $request = $this->crmTasksGetRequest($filterType, $filterStatus, $filterDate, $filterAssignTo, $filterContacts, $filterDeals, $filterCompanies, $dateFrom, $dateTo, $offset, $limit, $sort, $sortBy); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksGet' * * @param string $filterType Filter by task type (ID) (optional) * @param string $filterStatus Filter by task status (optional) * @param string $filterDate Filter by date (optional) * @param string $filterAssignTo Filter by assignTo id (optional) * @param string $filterContacts Filter by contact ids (optional) * @param string $filterDeals Filter by deals ids (optional) * @param string $filterCompanies Filter by companies ids (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksGetRequest($filterType = null, $filterStatus = null, $filterDate = null, $filterAssignTo = null, $filterContacts = null, $filterDeals = null, $filterCompanies = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $resourcePath = '/crm/tasks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($filterType !== null) { $queryParams['filter[type]'] = ObjectSerializer::toQueryValue($filterType); } // query params if ($filterStatus !== null) { $queryParams['filter[status]'] = ObjectSerializer::toQueryValue($filterStatus); } // query params if ($filterDate !== null) { $queryParams['filter[date]'] = ObjectSerializer::toQueryValue($filterDate); } // query params if ($filterAssignTo !== null) { $queryParams['filter[assignTo]'] = ObjectSerializer::toQueryValue($filterAssignTo); } // query params if ($filterContacts !== null) { $queryParams['filter[contacts]'] = ObjectSerializer::toQueryValue($filterContacts); } // query params if ($filterDeals !== null) { $queryParams['filter[deals]'] = ObjectSerializer::toQueryValue($filterDeals); } // query params if ($filterCompanies !== null) { $queryParams['filter[companies]'] = ObjectSerializer::toQueryValue($filterCompanies); } // query params if ($dateFrom !== null) { $queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom); } // query params if ($dateTo !== null) { $queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($sortBy !== null) { $queryParams['sortBy'] = ObjectSerializer::toQueryValue($sortBy); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdDelete * * Delete a task * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmTasksIdDelete($id) { $this->crmTasksIdDeleteWithHttpInfo($id); } /** * Operation crmTasksIdDeleteWithHttpInfo * * Delete a task * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmTasksIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdDeleteAsync * * Delete a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdDeleteAsync($id) { return $this->crmTasksIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdDeleteAsyncWithHttpInfo * * Delete a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmTasksIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdDelete' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdDelete' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdGet * * Get a task * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Task */ public function crmTasksIdGet($id) { list($response) = $this->crmTasksIdGetWithHttpInfo($id); return $response; } /** * Operation crmTasksIdGetWithHttpInfo * * Get a task * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Task, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Task'; $request = $this->crmTasksIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Task', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdGetAsync * * Get a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdGetAsync($id) { return $this->crmTasksIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdGetAsyncWithHttpInfo * * Get a task * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Task'; $request = $this->crmTasksIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdGet' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdGet' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksIdPatch * * Update a task * * @param string $id id (required) * @param \Brevo\Client\Model\Body7 $body Updated task details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmTasksIdPatch($id, $body) { $this->crmTasksIdPatchWithHttpInfo($id, $body); } /** * Operation crmTasksIdPatchWithHttpInfo * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body7 $body Updated task details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmTasksIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksIdPatchAsync * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body7 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdPatchAsync($id, $body) { return $this->crmTasksIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksIdPatchAsyncWithHttpInfo * * Update a task * * @param string $id (required) * @param \Brevo\Client\Model\Body7 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmTasksIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body7 $body Updated task details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmTasksIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmTasksIdPatch' ); } $resourcePath = '/crm/tasks/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasksPost * * Create a task * * @param \Brevo\Client\Model\Body6 $body Task name. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse2011 */ public function crmTasksPost($body) { list($response) = $this->crmTasksPostWithHttpInfo($body); return $response; } /** * Operation crmTasksPostWithHttpInfo * * Create a task * * @param \Brevo\Client\Model\Body6 $body Task name. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse2011, HTTP status code, HTTP response headers (array of strings) */ public function crmTasksPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse2011'; $request = $this->crmTasksPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse2011', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasksPostAsync * * Create a task * * @param \Brevo\Client\Model\Body6 $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksPostAsync($body) { return $this->crmTasksPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasksPostAsyncWithHttpInfo * * Create a task * * @param \Brevo\Client\Model\Body6 $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasksPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse2011'; $request = $this->crmTasksPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasksPost' * * @param \Brevo\Client\Model\Body6 $body Task name. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasksPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmTasksPost' ); } $resourcePath = '/crm/tasks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmTasktypesGet * * Get all task types * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\TaskTypes */ public function crmTasktypesGet() { list($response) = $this->crmTasktypesGetWithHttpInfo(); return $response; } /** * Operation crmTasktypesGetWithHttpInfo * * Get all task types * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\TaskTypes, HTTP status code, HTTP response headers (array of strings) */ public function crmTasktypesGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\TaskTypes'; $request = $this->crmTasktypesGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\TaskTypes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmTasktypesGetAsync * * Get all task types * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasktypesGetAsync() { return $this->crmTasktypesGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation crmTasktypesGetAsyncWithHttpInfo * * Get all task types * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmTasktypesGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\TaskTypes'; $request = $this->crmTasktypesGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmTasktypesGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmTasktypesGetRequest() { $resourcePath = '/crm/tasktypes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/FilesApi.php 0000644 00000160217 15021222673 0012141 0 ustar 00 <?php /** * FilesApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * FilesApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FilesApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation crmFilesGet * * Get all files * * @param string $entity Filter by file entity type (optional) * @param string $entityIds Filter by file entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\FileList */ public function crmFilesGet($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { list($response) = $this->crmFilesGetWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $response; } /** * Operation crmFilesGetWithHttpInfo * * Get all files * * @param string $entity Filter by file entity type (optional) * @param string $entityIds Filter by file entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\FileList, HTTP status code, HTTP response headers (array of strings) */ public function crmFilesGetWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\FileList'; $request = $this->crmFilesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\FileList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmFilesGetAsync * * Get all files * * @param string $entity Filter by file entity type (optional) * @param string $entityIds Filter by file entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesGetAsync($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { return $this->crmFilesGetAsyncWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmFilesGetAsyncWithHttpInfo * * Get all files * * @param string $entity Filter by file entity type (optional) * @param string $entityIds Filter by file entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesGetAsyncWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $returnType = '\Brevo\Client\Model\FileList'; $request = $this->crmFilesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmFilesGet' * * @param string $entity Filter by file entity type (optional) * @param string $entityIds Filter by file entity IDs (optional) * @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional) * @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmFilesGetRequest($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null) { $resourcePath = '/crm/files'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($entity !== null) { $queryParams['entity'] = ObjectSerializer::toQueryValue($entity); } // query params if ($entityIds !== null) { $queryParams['entityIds'] = ObjectSerializer::toQueryValue($entityIds); } // query params if ($dateFrom !== null) { $queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom); } // query params if ($dateTo !== null) { $queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmFilesIdDataGet * * Get file details * * @param string $id File id to get file data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\FileData */ public function crmFilesIdDataGet($id) { list($response) = $this->crmFilesIdDataGetWithHttpInfo($id); return $response; } /** * Operation crmFilesIdDataGetWithHttpInfo * * Get file details * * @param string $id File id to get file data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\FileData, HTTP status code, HTTP response headers (array of strings) */ public function crmFilesIdDataGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\FileData'; $request = $this->crmFilesIdDataGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\FileData', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmFilesIdDataGetAsync * * Get file details * * @param string $id File id to get file data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdDataGetAsync($id) { return $this->crmFilesIdDataGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmFilesIdDataGetAsyncWithHttpInfo * * Get file details * * @param string $id File id to get file data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdDataGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\FileData'; $request = $this->crmFilesIdDataGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmFilesIdDataGet' * * @param string $id File id to get file data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmFilesIdDataGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmFilesIdDataGet' ); } $resourcePath = '/crm/files/{id}/data'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmFilesIdDelete * * Delete a file * * @param string $id File id to delete. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmFilesIdDelete($id) { $this->crmFilesIdDeleteWithHttpInfo($id); } /** * Operation crmFilesIdDeleteWithHttpInfo * * Delete a file * * @param string $id File id to delete. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmFilesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmFilesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmFilesIdDeleteAsync * * Delete a file * * @param string $id File id to delete. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdDeleteAsync($id) { return $this->crmFilesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmFilesIdDeleteAsyncWithHttpInfo * * Delete a file * * @param string $id File id to delete. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmFilesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmFilesIdDelete' * * @param string $id File id to delete. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmFilesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmFilesIdDelete' ); } $resourcePath = '/crm/files/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmFilesIdGet * * Download a file * * @param string $id File id to download. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\FileDownloadableLink */ public function crmFilesIdGet($id) { list($response) = $this->crmFilesIdGetWithHttpInfo($id); return $response; } /** * Operation crmFilesIdGetWithHttpInfo * * Download a file * * @param string $id File id to download. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\FileDownloadableLink, HTTP status code, HTTP response headers (array of strings) */ public function crmFilesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\FileDownloadableLink'; $request = $this->crmFilesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\FileDownloadableLink', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmFilesIdGetAsync * * Download a file * * @param string $id File id to download. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdGetAsync($id) { return $this->crmFilesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmFilesIdGetAsyncWithHttpInfo * * Download a file * * @param string $id File id to download. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\FileDownloadableLink'; $request = $this->crmFilesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmFilesIdGet' * * @param string $id File id to download. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmFilesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmFilesIdGet' ); } $resourcePath = '/crm/files/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmFilesPost * * Upload a file * * @param \SplFileObject $file File data to create a file. (required) * @param string $dealId Deal id linked to a file (optional) * @param int $contactId Contact id linked to a file (optional) * @param string $companyId Company id linked to a file (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\FileData */ public function crmFilesPost($file, $dealId = null, $contactId = null, $companyId = null) { list($response) = $this->crmFilesPostWithHttpInfo($file, $dealId, $contactId, $companyId); return $response; } /** * Operation crmFilesPostWithHttpInfo * * Upload a file * * @param \SplFileObject $file File data to create a file. (required) * @param string $dealId Deal id linked to a file (optional) * @param int $contactId Contact id linked to a file (optional) * @param string $companyId Company id linked to a file (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\FileData, HTTP status code, HTTP response headers (array of strings) */ public function crmFilesPostWithHttpInfo($file, $dealId = null, $contactId = null, $companyId = null) { $returnType = '\Brevo\Client\Model\FileData'; $request = $this->crmFilesPostRequest($file, $dealId, $contactId, $companyId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\FileData', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmFilesPostAsync * * Upload a file * * @param \SplFileObject $file File data to create a file. (required) * @param string $dealId Deal id linked to a file (optional) * @param int $contactId Contact id linked to a file (optional) * @param string $companyId Company id linked to a file (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesPostAsync($file, $dealId = null, $contactId = null, $companyId = null) { return $this->crmFilesPostAsyncWithHttpInfo($file, $dealId, $contactId, $companyId) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmFilesPostAsyncWithHttpInfo * * Upload a file * * @param \SplFileObject $file File data to create a file. (required) * @param string $dealId Deal id linked to a file (optional) * @param int $contactId Contact id linked to a file (optional) * @param string $companyId Company id linked to a file (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmFilesPostAsyncWithHttpInfo($file, $dealId = null, $contactId = null, $companyId = null) { $returnType = '\Brevo\Client\Model\FileData'; $request = $this->crmFilesPostRequest($file, $dealId, $contactId, $companyId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmFilesPost' * * @param \SplFileObject $file File data to create a file. (required) * @param string $dealId Deal id linked to a file (optional) * @param int $contactId Contact id linked to a file (optional) * @param string $companyId Company id linked to a file (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmFilesPostRequest($file, $dealId = null, $contactId = null, $companyId = null) { // verify the required parameter 'file' is set if ($file === null || (is_array($file) && count($file) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $file when calling crmFilesPost' ); } $resourcePath = '/crm/files'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // form params if ($file !== null) { $multipart = true; $formParams['file'] = \GuzzleHttp\Psr7\try_fopen(ObjectSerializer::toFormValue($file), 'rb'); } // form params if ($dealId !== null) { $formParams['dealId'] = ObjectSerializer::toFormValue($dealId); } // form params if ($contactId !== null) { $formParams['contactId'] = ObjectSerializer::toFormValue($contactId); } // form params if ($companyId !== null) { $formParams['companyId'] = ObjectSerializer::toFormValue($companyId); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['multipart/form-data'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ResellerApi.php 0000644 00000532427 15021222673 0012662 0 ustar 00 <?php /** * ResellerApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ResellerApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ResellerApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation addCredits * * Add Email and/or SMS credits to a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddCredits $addCredits Values to post to add credit to a specific child account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\RemainingCreditModel */ public function addCredits($childIdentifier, $addCredits) { list($response) = $this->addCreditsWithHttpInfo($childIdentifier, $addCredits); return $response; } /** * Operation addCreditsWithHttpInfo * * Add Email and/or SMS credits to a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddCredits $addCredits Values to post to add credit to a specific child account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\RemainingCreditModel, HTTP status code, HTTP response headers (array of strings) */ public function addCreditsWithHttpInfo($childIdentifier, $addCredits) { $returnType = '\Brevo\Client\Model\RemainingCreditModel'; $request = $this->addCreditsRequest($childIdentifier, $addCredits); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\RemainingCreditModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation addCreditsAsync * * Add Email and/or SMS credits to a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddCredits $addCredits Values to post to add credit to a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addCreditsAsync($childIdentifier, $addCredits) { return $this->addCreditsAsyncWithHttpInfo($childIdentifier, $addCredits) ->then( function ($response) { return $response[0]; } ); } /** * Operation addCreditsAsyncWithHttpInfo * * Add Email and/or SMS credits to a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddCredits $addCredits Values to post to add credit to a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addCreditsAsyncWithHttpInfo($childIdentifier, $addCredits) { $returnType = '\Brevo\Client\Model\RemainingCreditModel'; $request = $this->addCreditsRequest($childIdentifier, $addCredits); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'addCredits' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddCredits $addCredits Values to post to add credit to a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function addCreditsRequest($childIdentifier, $addCredits) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling addCredits' ); } // verify the required parameter 'addCredits' is set if ($addCredits === null || (is_array($addCredits) && count($addCredits) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $addCredits when calling addCredits' ); } $resourcePath = '/reseller/children/{childIdentifier}/credits/add'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($addCredits)) { $_tempBody = $addCredits; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation associateIpToChild * * Associate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to associate (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function associateIpToChild($childIdentifier, $ip) { $this->associateIpToChildWithHttpInfo($childIdentifier, $ip); } /** * Operation associateIpToChildWithHttpInfo * * Associate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to associate (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function associateIpToChildWithHttpInfo($childIdentifier, $ip) { $returnType = ''; $request = $this->associateIpToChildRequest($childIdentifier, $ip); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation associateIpToChildAsync * * Associate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to associate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function associateIpToChildAsync($childIdentifier, $ip) { return $this->associateIpToChildAsyncWithHttpInfo($childIdentifier, $ip) ->then( function ($response) { return $response[0]; } ); } /** * Operation associateIpToChildAsyncWithHttpInfo * * Associate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to associate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function associateIpToChildAsyncWithHttpInfo($childIdentifier, $ip) { $returnType = ''; $request = $this->associateIpToChildRequest($childIdentifier, $ip); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'associateIpToChild' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to associate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function associateIpToChildRequest($childIdentifier, $ip) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling associateIpToChild' ); } // verify the required parameter 'ip' is set if ($ip === null || (is_array($ip) && count($ip) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $ip when calling associateIpToChild' ); } $resourcePath = '/reseller/children/{childIdentifier}/ips/associate'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($ip)) { $_tempBody = $ip; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createChildDomain * * Create a domain for a child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddChildDomain $addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createChildDomain($childIdentifier, $addChildDomain) { $this->createChildDomainWithHttpInfo($childIdentifier, $addChildDomain); } /** * Operation createChildDomainWithHttpInfo * * Create a domain for a child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddChildDomain $addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createChildDomainWithHttpInfo($childIdentifier, $addChildDomain) { $returnType = ''; $request = $this->createChildDomainRequest($childIdentifier, $addChildDomain); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createChildDomainAsync * * Create a domain for a child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddChildDomain $addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createChildDomainAsync($childIdentifier, $addChildDomain) { return $this->createChildDomainAsyncWithHttpInfo($childIdentifier, $addChildDomain) ->then( function ($response) { return $response[0]; } ); } /** * Operation createChildDomainAsyncWithHttpInfo * * Create a domain for a child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddChildDomain $addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createChildDomainAsyncWithHttpInfo($childIdentifier, $addChildDomain) { $returnType = ''; $request = $this->createChildDomainRequest($childIdentifier, $addChildDomain); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createChildDomain' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\AddChildDomain $addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createChildDomainRequest($childIdentifier, $addChildDomain) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling createChildDomain' ); } // verify the required parameter 'addChildDomain' is set if ($addChildDomain === null || (is_array($addChildDomain) && count($addChildDomain) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $addChildDomain when calling createChildDomain' ); } $resourcePath = '/reseller/children/{childIdentifier}/domains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($addChildDomain)) { $_tempBody = $addChildDomain; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createResellerChild * * Creates a reseller child * * @param \Brevo\Client\Model\CreateChild $resellerChild reseller child to add (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateReseller */ public function createResellerChild($resellerChild = null) { list($response) = $this->createResellerChildWithHttpInfo($resellerChild); return $response; } /** * Operation createResellerChildWithHttpInfo * * Creates a reseller child * * @param \Brevo\Client\Model\CreateChild $resellerChild reseller child to add (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateReseller, HTTP status code, HTTP response headers (array of strings) */ public function createResellerChildWithHttpInfo($resellerChild = null) { $returnType = '\Brevo\Client\Model\CreateReseller'; $request = $this->createResellerChildRequest($resellerChild); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateReseller', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createResellerChildAsync * * Creates a reseller child * * @param \Brevo\Client\Model\CreateChild $resellerChild reseller child to add (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createResellerChildAsync($resellerChild = null) { return $this->createResellerChildAsyncWithHttpInfo($resellerChild) ->then( function ($response) { return $response[0]; } ); } /** * Operation createResellerChildAsyncWithHttpInfo * * Creates a reseller child * * @param \Brevo\Client\Model\CreateChild $resellerChild reseller child to add (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createResellerChildAsyncWithHttpInfo($resellerChild = null) { $returnType = '\Brevo\Client\Model\CreateReseller'; $request = $this->createResellerChildRequest($resellerChild); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createResellerChild' * * @param \Brevo\Client\Model\CreateChild $resellerChild reseller child to add (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createResellerChildRequest($resellerChild = null) { $resourcePath = '/reseller/children'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($resellerChild)) { $_tempBody = $resellerChild; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteChildDomain * * Delete the sender domain of the reseller child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteChildDomain($childIdentifier, $domainName) { $this->deleteChildDomainWithHttpInfo($childIdentifier, $domainName); } /** * Operation deleteChildDomainWithHttpInfo * * Delete the sender domain of the reseller child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be deleted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteChildDomainWithHttpInfo($childIdentifier, $domainName) { $returnType = ''; $request = $this->deleteChildDomainRequest($childIdentifier, $domainName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteChildDomainAsync * * Delete the sender domain of the reseller child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteChildDomainAsync($childIdentifier, $domainName) { return $this->deleteChildDomainAsyncWithHttpInfo($childIdentifier, $domainName) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteChildDomainAsyncWithHttpInfo * * Delete the sender domain of the reseller child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteChildDomainAsyncWithHttpInfo($childIdentifier, $domainName) { $returnType = ''; $request = $this->deleteChildDomainRequest($childIdentifier, $domainName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteChildDomain' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be deleted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteChildDomainRequest($childIdentifier, $domainName) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling deleteChildDomain' ); } // verify the required parameter 'domainName' is set if ($domainName === null || (is_array($domainName) && count($domainName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domainName when calling deleteChildDomain' ); } $resourcePath = '/reseller/children/{childIdentifier}/domains/{domainName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // path params if ($domainName !== null) { $resourcePath = str_replace( '{' . 'domainName' . '}', ObjectSerializer::toPathValue($domainName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteResellerChild * * Delete a single reseller child based on the child identifier supplied * * @param string $childIdentifier Either auth key or child id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteResellerChild($childIdentifier) { $this->deleteResellerChildWithHttpInfo($childIdentifier); } /** * Operation deleteResellerChildWithHttpInfo * * Delete a single reseller child based on the child identifier supplied * * @param string $childIdentifier Either auth key or child id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteResellerChildWithHttpInfo($childIdentifier) { $returnType = ''; $request = $this->deleteResellerChildRequest($childIdentifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteResellerChildAsync * * Delete a single reseller child based on the child identifier supplied * * @param string $childIdentifier Either auth key or child id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteResellerChildAsync($childIdentifier) { return $this->deleteResellerChildAsyncWithHttpInfo($childIdentifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteResellerChildAsyncWithHttpInfo * * Delete a single reseller child based on the child identifier supplied * * @param string $childIdentifier Either auth key or child id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteResellerChildAsyncWithHttpInfo($childIdentifier) { $returnType = ''; $request = $this->deleteResellerChildRequest($childIdentifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteResellerChild' * * @param string $childIdentifier Either auth key or child id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteResellerChildRequest($childIdentifier) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling deleteResellerChild' ); } $resourcePath = '/reseller/children/{childIdentifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation dissociateIpFromChild * * Dissociate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to dissociate (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function dissociateIpFromChild($childIdentifier, $ip) { $this->dissociateIpFromChildWithHttpInfo($childIdentifier, $ip); } /** * Operation dissociateIpFromChildWithHttpInfo * * Dissociate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to dissociate (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function dissociateIpFromChildWithHttpInfo($childIdentifier, $ip) { $returnType = ''; $request = $this->dissociateIpFromChildRequest($childIdentifier, $ip); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation dissociateIpFromChildAsync * * Dissociate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to dissociate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function dissociateIpFromChildAsync($childIdentifier, $ip) { return $this->dissociateIpFromChildAsyncWithHttpInfo($childIdentifier, $ip) ->then( function ($response) { return $response[0]; } ); } /** * Operation dissociateIpFromChildAsyncWithHttpInfo * * Dissociate a dedicated IP to the child * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to dissociate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function dissociateIpFromChildAsyncWithHttpInfo($childIdentifier, $ip) { $returnType = ''; $request = $this->dissociateIpFromChildRequest($childIdentifier, $ip); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'dissociateIpFromChild' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\ManageIp $ip IP to dissociate (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function dissociateIpFromChildRequest($childIdentifier, $ip) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling dissociateIpFromChild' ); } // verify the required parameter 'ip' is set if ($ip === null || (is_array($ip) && count($ip) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $ip when calling dissociateIpFromChild' ); } $resourcePath = '/reseller/children/{childIdentifier}/ips/dissociate'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($ip)) { $_tempBody = $ip; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getChildAccountCreationStatus * * Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetChildAccountCreationStatus */ public function getChildAccountCreationStatus($childIdentifier) { list($response) = $this->getChildAccountCreationStatusWithHttpInfo($childIdentifier); return $response; } /** * Operation getChildAccountCreationStatusWithHttpInfo * * Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetChildAccountCreationStatus, HTTP status code, HTTP response headers (array of strings) */ public function getChildAccountCreationStatusWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildAccountCreationStatus'; $request = $this->getChildAccountCreationStatusRequest($childIdentifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetChildAccountCreationStatus', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getChildAccountCreationStatusAsync * * Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildAccountCreationStatusAsync($childIdentifier) { return $this->getChildAccountCreationStatusAsyncWithHttpInfo($childIdentifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation getChildAccountCreationStatusAsyncWithHttpInfo * * Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildAccountCreationStatusAsyncWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildAccountCreationStatus'; $request = $this->getChildAccountCreationStatusRequest($childIdentifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getChildAccountCreationStatus' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getChildAccountCreationStatusRequest($childIdentifier) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling getChildAccountCreationStatus' ); } $resourcePath = '/reseller/children/{childIdentifier}/accountCreationStatus'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getChildDomains * * Get all sender domains for a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetChildDomains */ public function getChildDomains($childIdentifier) { list($response) = $this->getChildDomainsWithHttpInfo($childIdentifier); return $response; } /** * Operation getChildDomainsWithHttpInfo * * Get all sender domains for a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetChildDomains, HTTP status code, HTTP response headers (array of strings) */ public function getChildDomainsWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildDomains'; $request = $this->getChildDomainsRequest($childIdentifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetChildDomains', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getChildDomainsAsync * * Get all sender domains for a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildDomainsAsync($childIdentifier) { return $this->getChildDomainsAsyncWithHttpInfo($childIdentifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation getChildDomainsAsyncWithHttpInfo * * Get all sender domains for a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildDomainsAsyncWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildDomains'; $request = $this->getChildDomainsRequest($childIdentifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getChildDomains' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getChildDomainsRequest($childIdentifier) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling getChildDomains' ); } $resourcePath = '/reseller/children/{childIdentifier}/domains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getChildInfo * * Get a child account's details * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetChildInfo */ public function getChildInfo($childIdentifier) { list($response) = $this->getChildInfoWithHttpInfo($childIdentifier); return $response; } /** * Operation getChildInfoWithHttpInfo * * Get a child account's details * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetChildInfo, HTTP status code, HTTP response headers (array of strings) */ public function getChildInfoWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildInfo'; $request = $this->getChildInfoRequest($childIdentifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetChildInfo', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getChildInfoAsync * * Get a child account's details * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildInfoAsync($childIdentifier) { return $this->getChildInfoAsyncWithHttpInfo($childIdentifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation getChildInfoAsyncWithHttpInfo * * Get a child account's details * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getChildInfoAsyncWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetChildInfo'; $request = $this->getChildInfoRequest($childIdentifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getChildInfo' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getChildInfoRequest($childIdentifier) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling getChildInfo' ); } $resourcePath = '/reseller/children/{childIdentifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getResellerChilds * * Get the list of all children accounts * * @param int $limit Number of documents for child accounts information per page (optional, default to 10) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetChildrenList */ public function getResellerChilds($limit = '10', $offset = '0') { list($response) = $this->getResellerChildsWithHttpInfo($limit, $offset); return $response; } /** * Operation getResellerChildsWithHttpInfo * * Get the list of all children accounts * * @param int $limit Number of documents for child accounts information per page (optional, default to 10) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetChildrenList, HTTP status code, HTTP response headers (array of strings) */ public function getResellerChildsWithHttpInfo($limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetChildrenList'; $request = $this->getResellerChildsRequest($limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetChildrenList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getResellerChildsAsync * * Get the list of all children accounts * * @param int $limit Number of documents for child accounts information per page (optional, default to 10) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getResellerChildsAsync($limit = '10', $offset = '0') { return $this->getResellerChildsAsyncWithHttpInfo($limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getResellerChildsAsyncWithHttpInfo * * Get the list of all children accounts * * @param int $limit Number of documents for child accounts information per page (optional, default to 10) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getResellerChildsAsyncWithHttpInfo($limit = '10', $offset = '0') { $returnType = '\Brevo\Client\Model\GetChildrenList'; $request = $this->getResellerChildsRequest($limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getResellerChilds' * * @param int $limit Number of documents for child accounts information per page (optional, default to 10) * @param int $offset Index of the first document in the page (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getResellerChildsRequest($limit = '10', $offset = '0') { if ($limit !== null && $limit > 20) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ResellerApi.getResellerChilds, must be smaller than or equal to 20.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ResellerApi.getResellerChilds, must be bigger than or equal to 0.'); } $resourcePath = '/reseller/children'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSsoToken * * Get session token to access Brevo (SSO) * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSsoToken */ public function getSsoToken($childIdentifier) { list($response) = $this->getSsoTokenWithHttpInfo($childIdentifier); return $response; } /** * Operation getSsoTokenWithHttpInfo * * Get session token to access Brevo (SSO) * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSsoToken, HTTP status code, HTTP response headers (array of strings) */ public function getSsoTokenWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetSsoToken'; $request = $this->getSsoTokenRequest($childIdentifier); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSsoToken', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSsoTokenAsync * * Get session token to access Brevo (SSO) * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSsoTokenAsync($childIdentifier) { return $this->getSsoTokenAsyncWithHttpInfo($childIdentifier) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSsoTokenAsyncWithHttpInfo * * Get session token to access Brevo (SSO) * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSsoTokenAsyncWithHttpInfo($childIdentifier) { $returnType = '\Brevo\Client\Model\GetSsoToken'; $request = $this->getSsoTokenRequest($childIdentifier); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSsoToken' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSsoTokenRequest($childIdentifier) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling getSsoToken' ); } $resourcePath = '/reseller/children/{childIdentifier}/auth'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation removeCredits * * Remove Email and/or SMS credits from a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\RemoveCredits $removeCredits Values to post to remove email or SMS credits from a specific child account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\RemainingCreditModel */ public function removeCredits($childIdentifier, $removeCredits) { list($response) = $this->removeCreditsWithHttpInfo($childIdentifier, $removeCredits); return $response; } /** * Operation removeCreditsWithHttpInfo * * Remove Email and/or SMS credits from a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\RemoveCredits $removeCredits Values to post to remove email or SMS credits from a specific child account (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\RemainingCreditModel, HTTP status code, HTTP response headers (array of strings) */ public function removeCreditsWithHttpInfo($childIdentifier, $removeCredits) { $returnType = '\Brevo\Client\Model\RemainingCreditModel'; $request = $this->removeCreditsRequest($childIdentifier, $removeCredits); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\RemainingCreditModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation removeCreditsAsync * * Remove Email and/or SMS credits from a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\RemoveCredits $removeCredits Values to post to remove email or SMS credits from a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeCreditsAsync($childIdentifier, $removeCredits) { return $this->removeCreditsAsyncWithHttpInfo($childIdentifier, $removeCredits) ->then( function ($response) { return $response[0]; } ); } /** * Operation removeCreditsAsyncWithHttpInfo * * Remove Email and/or SMS credits from a specific child account * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\RemoveCredits $removeCredits Values to post to remove email or SMS credits from a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeCreditsAsyncWithHttpInfo($childIdentifier, $removeCredits) { $returnType = '\Brevo\Client\Model\RemainingCreditModel'; $request = $this->removeCreditsRequest($childIdentifier, $removeCredits); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'removeCredits' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\RemoveCredits $removeCredits Values to post to remove email or SMS credits from a specific child account (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function removeCreditsRequest($childIdentifier, $removeCredits) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling removeCredits' ); } // verify the required parameter 'removeCredits' is set if ($removeCredits === null || (is_array($removeCredits) && count($removeCredits) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $removeCredits when calling removeCredits' ); } $resourcePath = '/reseller/children/{childIdentifier}/credits/remove'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($removeCredits)) { $_tempBody = $removeCredits; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateChildAccountStatus * * Update info of reseller's child account status based on the childIdentifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChildAccountStatus $updateChildAccountStatus values to update in child account status (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateChildAccountStatus($childIdentifier, $updateChildAccountStatus) { $this->updateChildAccountStatusWithHttpInfo($childIdentifier, $updateChildAccountStatus); } /** * Operation updateChildAccountStatusWithHttpInfo * * Update info of reseller's child account status based on the childIdentifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChildAccountStatus $updateChildAccountStatus values to update in child account status (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateChildAccountStatusWithHttpInfo($childIdentifier, $updateChildAccountStatus) { $returnType = ''; $request = $this->updateChildAccountStatusRequest($childIdentifier, $updateChildAccountStatus); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateChildAccountStatusAsync * * Update info of reseller's child account status based on the childIdentifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChildAccountStatus $updateChildAccountStatus values to update in child account status (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateChildAccountStatusAsync($childIdentifier, $updateChildAccountStatus) { return $this->updateChildAccountStatusAsyncWithHttpInfo($childIdentifier, $updateChildAccountStatus) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateChildAccountStatusAsyncWithHttpInfo * * Update info of reseller's child account status based on the childIdentifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChildAccountStatus $updateChildAccountStatus values to update in child account status (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateChildAccountStatusAsyncWithHttpInfo($childIdentifier, $updateChildAccountStatus) { $returnType = ''; $request = $this->updateChildAccountStatusRequest($childIdentifier, $updateChildAccountStatus); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateChildAccountStatus' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChildAccountStatus $updateChildAccountStatus values to update in child account status (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateChildAccountStatusRequest($childIdentifier, $updateChildAccountStatus) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling updateChildAccountStatus' ); } // verify the required parameter 'updateChildAccountStatus' is set if ($updateChildAccountStatus === null || (is_array($updateChildAccountStatus) && count($updateChildAccountStatus) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateChildAccountStatus when calling updateChildAccountStatus' ); } $resourcePath = '/reseller/children/{childIdentifier}/accountStatus'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($updateChildAccountStatus)) { $_tempBody = $updateChildAccountStatus; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateChildDomain * * Update the sender domain of reseller's child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be updated (required) * @param \Brevo\Client\Model\UpdateChildDomain $updateChildDomain value to update for sender domain (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateChildDomain($childIdentifier, $domainName, $updateChildDomain) { $this->updateChildDomainWithHttpInfo($childIdentifier, $domainName, $updateChildDomain); } /** * Operation updateChildDomainWithHttpInfo * * Update the sender domain of reseller's child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be updated (required) * @param \Brevo\Client\Model\UpdateChildDomain $updateChildDomain value to update for sender domain (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateChildDomainWithHttpInfo($childIdentifier, $domainName, $updateChildDomain) { $returnType = ''; $request = $this->updateChildDomainRequest($childIdentifier, $domainName, $updateChildDomain); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateChildDomainAsync * * Update the sender domain of reseller's child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be updated (required) * @param \Brevo\Client\Model\UpdateChildDomain $updateChildDomain value to update for sender domain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateChildDomainAsync($childIdentifier, $domainName, $updateChildDomain) { return $this->updateChildDomainAsyncWithHttpInfo($childIdentifier, $domainName, $updateChildDomain) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateChildDomainAsyncWithHttpInfo * * Update the sender domain of reseller's child based on the childIdentifier and domainName passed * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be updated (required) * @param \Brevo\Client\Model\UpdateChildDomain $updateChildDomain value to update for sender domain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateChildDomainAsyncWithHttpInfo($childIdentifier, $domainName, $updateChildDomain) { $returnType = ''; $request = $this->updateChildDomainRequest($childIdentifier, $domainName, $updateChildDomain); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateChildDomain' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param string $domainName Pass the existing domain that needs to be updated (required) * @param \Brevo\Client\Model\UpdateChildDomain $updateChildDomain value to update for sender domain (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateChildDomainRequest($childIdentifier, $domainName, $updateChildDomain) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling updateChildDomain' ); } // verify the required parameter 'domainName' is set if ($domainName === null || (is_array($domainName) && count($domainName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domainName when calling updateChildDomain' ); } // verify the required parameter 'updateChildDomain' is set if ($updateChildDomain === null || (is_array($updateChildDomain) && count($updateChildDomain) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateChildDomain when calling updateChildDomain' ); } $resourcePath = '/reseller/children/{childIdentifier}/domains/{domainName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // path params if ($domainName !== null) { $resourcePath = str_replace( '{' . 'domainName' . '}', ObjectSerializer::toPathValue($domainName), $resourcePath ); } // body params $_tempBody = null; if (isset($updateChildDomain)) { $_tempBody = $updateChildDomain; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateResellerChild * * Update info of reseller's child based on the child identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChild $resellerChild values to update in child profile (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateResellerChild($childIdentifier, $resellerChild) { $this->updateResellerChildWithHttpInfo($childIdentifier, $resellerChild); } /** * Operation updateResellerChildWithHttpInfo * * Update info of reseller's child based on the child identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChild $resellerChild values to update in child profile (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateResellerChildWithHttpInfo($childIdentifier, $resellerChild) { $returnType = ''; $request = $this->updateResellerChildRequest($childIdentifier, $resellerChild); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 403: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateResellerChildAsync * * Update info of reseller's child based on the child identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChild $resellerChild values to update in child profile (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateResellerChildAsync($childIdentifier, $resellerChild) { return $this->updateResellerChildAsyncWithHttpInfo($childIdentifier, $resellerChild) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateResellerChildAsyncWithHttpInfo * * Update info of reseller's child based on the child identifier supplied * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChild $resellerChild values to update in child profile (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateResellerChildAsyncWithHttpInfo($childIdentifier, $resellerChild) { $returnType = ''; $request = $this->updateResellerChildRequest($childIdentifier, $resellerChild); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateResellerChild' * * @param string $childIdentifier Either auth key or id of reseller's child (required) * @param \Brevo\Client\Model\UpdateChild $resellerChild values to update in child profile (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateResellerChildRequest($childIdentifier, $resellerChild) { // verify the required parameter 'childIdentifier' is set if ($childIdentifier === null || (is_array($childIdentifier) && count($childIdentifier) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $childIdentifier when calling updateResellerChild' ); } // verify the required parameter 'resellerChild' is set if ($resellerChild === null || (is_array($resellerChild) && count($resellerChild) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $resellerChild when calling updateResellerChild' ); } $resourcePath = '/reseller/children/{childIdentifier}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($childIdentifier !== null) { $resourcePath = str_replace( '{' . 'childIdentifier' . '}', ObjectSerializer::toPathValue($childIdentifier), $resourcePath ); } // body params $_tempBody = null; if (isset($resellerChild)) { $_tempBody = $resellerChild; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/DomainsApi.php 0000644 00000143621 15021222673 0012471 0 ustar 00 <?php /** * DomainsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * DomainsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DomainsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation authenticateDomain * * Authenticate a domain * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\AuthenticateDomainModel */ public function authenticateDomain($domainName) { list($response) = $this->authenticateDomainWithHttpInfo($domainName); return $response; } /** * Operation authenticateDomainWithHttpInfo * * Authenticate a domain * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\AuthenticateDomainModel, HTTP status code, HTTP response headers (array of strings) */ public function authenticateDomainWithHttpInfo($domainName) { $returnType = '\Brevo\Client\Model\AuthenticateDomainModel'; $request = $this->authenticateDomainRequest($domainName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\AuthenticateDomainModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation authenticateDomainAsync * * Authenticate a domain * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function authenticateDomainAsync($domainName) { return $this->authenticateDomainAsyncWithHttpInfo($domainName) ->then( function ($response) { return $response[0]; } ); } /** * Operation authenticateDomainAsyncWithHttpInfo * * Authenticate a domain * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function authenticateDomainAsyncWithHttpInfo($domainName) { $returnType = '\Brevo\Client\Model\AuthenticateDomainModel'; $request = $this->authenticateDomainRequest($domainName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'authenticateDomain' * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function authenticateDomainRequest($domainName) { // verify the required parameter 'domainName' is set if ($domainName === null || (is_array($domainName) && count($domainName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domainName when calling authenticateDomain' ); } $resourcePath = '/senders/domains/{domainName}/authenticate'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($domainName !== null) { $resourcePath = str_replace( '{' . 'domainName' . '}', ObjectSerializer::toPathValue($domainName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createDomain * * Create a new domain * * @param \Brevo\Client\Model\CreateDomain $domainName domain's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateDomainModel */ public function createDomain($domainName = null) { list($response) = $this->createDomainWithHttpInfo($domainName); return $response; } /** * Operation createDomainWithHttpInfo * * Create a new domain * * @param \Brevo\Client\Model\CreateDomain $domainName domain's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateDomainModel, HTTP status code, HTTP response headers (array of strings) */ public function createDomainWithHttpInfo($domainName = null) { $returnType = '\Brevo\Client\Model\CreateDomainModel'; $request = $this->createDomainRequest($domainName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateDomainModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createDomainAsync * * Create a new domain * * @param \Brevo\Client\Model\CreateDomain $domainName domain's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createDomainAsync($domainName = null) { return $this->createDomainAsyncWithHttpInfo($domainName) ->then( function ($response) { return $response[0]; } ); } /** * Operation createDomainAsyncWithHttpInfo * * Create a new domain * * @param \Brevo\Client\Model\CreateDomain $domainName domain's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createDomainAsyncWithHttpInfo($domainName = null) { $returnType = '\Brevo\Client\Model\CreateDomainModel'; $request = $this->createDomainRequest($domainName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createDomain' * * @param \Brevo\Client\Model\CreateDomain $domainName domain's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createDomainRequest($domainName = null) { $resourcePath = '/senders/domains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($domainName)) { $_tempBody = $domainName; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteDomain * * Delete a domain * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteDomain($domainName) { $this->deleteDomainWithHttpInfo($domainName); } /** * Operation deleteDomainWithHttpInfo * * Delete a domain * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteDomainWithHttpInfo($domainName) { $returnType = ''; $request = $this->deleteDomainRequest($domainName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteDomainAsync * * Delete a domain * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteDomainAsync($domainName) { return $this->deleteDomainAsyncWithHttpInfo($domainName) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteDomainAsyncWithHttpInfo * * Delete a domain * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteDomainAsyncWithHttpInfo($domainName) { $returnType = ''; $request = $this->deleteDomainRequest($domainName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteDomain' * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteDomainRequest($domainName) { // verify the required parameter 'domainName' is set if ($domainName === null || (is_array($domainName) && count($domainName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domainName when calling deleteDomain' ); } $resourcePath = '/senders/domains/{domainName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($domainName !== null) { $resourcePath = str_replace( '{' . 'domainName' . '}', ObjectSerializer::toPathValue($domainName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getDomainConfiguration * * Validate domain configuration * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetDomainConfigurationModel */ public function getDomainConfiguration($domainName) { list($response) = $this->getDomainConfigurationWithHttpInfo($domainName); return $response; } /** * Operation getDomainConfigurationWithHttpInfo * * Validate domain configuration * * @param string $domainName Domain name (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetDomainConfigurationModel, HTTP status code, HTTP response headers (array of strings) */ public function getDomainConfigurationWithHttpInfo($domainName) { $returnType = '\Brevo\Client\Model\GetDomainConfigurationModel'; $request = $this->getDomainConfigurationRequest($domainName); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetDomainConfigurationModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getDomainConfigurationAsync * * Validate domain configuration * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getDomainConfigurationAsync($domainName) { return $this->getDomainConfigurationAsyncWithHttpInfo($domainName) ->then( function ($response) { return $response[0]; } ); } /** * Operation getDomainConfigurationAsyncWithHttpInfo * * Validate domain configuration * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getDomainConfigurationAsyncWithHttpInfo($domainName) { $returnType = '\Brevo\Client\Model\GetDomainConfigurationModel'; $request = $this->getDomainConfigurationRequest($domainName); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getDomainConfiguration' * * @param string $domainName Domain name (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getDomainConfigurationRequest($domainName) { // verify the required parameter 'domainName' is set if ($domainName === null || (is_array($domainName) && count($domainName) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $domainName when calling getDomainConfiguration' ); } $resourcePath = '/senders/domains/{domainName}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($domainName !== null) { $resourcePath = str_replace( '{' . 'domainName' . '}', ObjectSerializer::toPathValue($domainName), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getDomains * * Get the list of all your domains * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetDomainsList */ public function getDomains() { list($response) = $this->getDomainsWithHttpInfo(); return $response; } /** * Operation getDomainsWithHttpInfo * * Get the list of all your domains * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetDomainsList, HTTP status code, HTTP response headers (array of strings) */ public function getDomainsWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetDomainsList'; $request = $this->getDomainsRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetDomainsList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getDomainsAsync * * Get the list of all your domains * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getDomainsAsync() { return $this->getDomainsAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getDomainsAsyncWithHttpInfo * * Get the list of all your domains * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getDomainsAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetDomainsList'; $request = $this->getDomainsRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getDomains' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getDomainsRequest() { $resourcePath = '/senders/domains'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ExternalFeedsApi.php 0000644 00000162607 15021222673 0013635 0 ustar 00 <?php /** * ExternalFeedsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ExternalFeedsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ExternalFeedsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createExternalFeed * * Create an external feed * * @param \Brevo\Client\Model\CreateExternalFeed $createExternalFeed Values to create a feed (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse2014 */ public function createExternalFeed($createExternalFeed) { list($response) = $this->createExternalFeedWithHttpInfo($createExternalFeed); return $response; } /** * Operation createExternalFeedWithHttpInfo * * Create an external feed * * @param \Brevo\Client\Model\CreateExternalFeed $createExternalFeed Values to create a feed (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse2014, HTTP status code, HTTP response headers (array of strings) */ public function createExternalFeedWithHttpInfo($createExternalFeed) { $returnType = '\Brevo\Client\Model\InlineResponse2014'; $request = $this->createExternalFeedRequest($createExternalFeed); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse2014', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createExternalFeedAsync * * Create an external feed * * @param \Brevo\Client\Model\CreateExternalFeed $createExternalFeed Values to create a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createExternalFeedAsync($createExternalFeed) { return $this->createExternalFeedAsyncWithHttpInfo($createExternalFeed) ->then( function ($response) { return $response[0]; } ); } /** * Operation createExternalFeedAsyncWithHttpInfo * * Create an external feed * * @param \Brevo\Client\Model\CreateExternalFeed $createExternalFeed Values to create a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createExternalFeedAsyncWithHttpInfo($createExternalFeed) { $returnType = '\Brevo\Client\Model\InlineResponse2014'; $request = $this->createExternalFeedRequest($createExternalFeed); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createExternalFeed' * * @param \Brevo\Client\Model\CreateExternalFeed $createExternalFeed Values to create a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createExternalFeedRequest($createExternalFeed) { // verify the required parameter 'createExternalFeed' is set if ($createExternalFeed === null || (is_array($createExternalFeed) && count($createExternalFeed) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createExternalFeed when calling createExternalFeed' ); } $resourcePath = '/feeds'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createExternalFeed)) { $_tempBody = $createExternalFeed; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteExternalFeed * * Delete an external feed * * @param string $uuid UUID of the feed to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteExternalFeed($uuid) { $this->deleteExternalFeedWithHttpInfo($uuid); } /** * Operation deleteExternalFeedWithHttpInfo * * Delete an external feed * * @param string $uuid UUID of the feed to delete (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteExternalFeedWithHttpInfo($uuid) { $returnType = ''; $request = $this->deleteExternalFeedRequest($uuid); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteExternalFeedAsync * * Delete an external feed * * @param string $uuid UUID of the feed to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteExternalFeedAsync($uuid) { return $this->deleteExternalFeedAsyncWithHttpInfo($uuid) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteExternalFeedAsyncWithHttpInfo * * Delete an external feed * * @param string $uuid UUID of the feed to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteExternalFeedAsyncWithHttpInfo($uuid) { $returnType = ''; $request = $this->deleteExternalFeedRequest($uuid); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteExternalFeed' * * @param string $uuid UUID of the feed to delete (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteExternalFeedRequest($uuid) { // verify the required parameter 'uuid' is set if ($uuid === null || (is_array($uuid) && count($uuid) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uuid when calling deleteExternalFeed' ); } $resourcePath = '/feeds/{uuid}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($uuid !== null) { $resourcePath = str_replace( '{' . 'uuid' . '}', ObjectSerializer::toPathValue($uuid), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getAllExternalFeeds * * Fetch all external feeds * * @param string $search Can be used to filter records by search keyword on feed name (optional) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc) * @param string $authType Filter the records by `authType` of the feed. (optional) * @param int $limit Number of documents returned per page. (optional, default to 50) * @param int $offset Index of the first document on the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetAllExternalFeeds */ public function getAllExternalFeeds($search = null, $startDate = null, $endDate = null, $sort = 'desc', $authType = null, $limit = '50', $offset = '0') { list($response) = $this->getAllExternalFeedsWithHttpInfo($search, $startDate, $endDate, $sort, $authType, $limit, $offset); return $response; } /** * Operation getAllExternalFeedsWithHttpInfo * * Fetch all external feeds * * @param string $search Can be used to filter records by search keyword on feed name (optional) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc) * @param string $authType Filter the records by `authType` of the feed. (optional) * @param int $limit Number of documents returned per page. (optional, default to 50) * @param int $offset Index of the first document on the page. (optional, default to 0) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetAllExternalFeeds, HTTP status code, HTTP response headers (array of strings) */ public function getAllExternalFeedsWithHttpInfo($search = null, $startDate = null, $endDate = null, $sort = 'desc', $authType = null, $limit = '50', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAllExternalFeeds'; $request = $this->getAllExternalFeedsRequest($search, $startDate, $endDate, $sort, $authType, $limit, $offset); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetAllExternalFeeds', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getAllExternalFeedsAsync * * Fetch all external feeds * * @param string $search Can be used to filter records by search keyword on feed name (optional) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc) * @param string $authType Filter the records by `authType` of the feed. (optional) * @param int $limit Number of documents returned per page. (optional, default to 50) * @param int $offset Index of the first document on the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAllExternalFeedsAsync($search = null, $startDate = null, $endDate = null, $sort = 'desc', $authType = null, $limit = '50', $offset = '0') { return $this->getAllExternalFeedsAsyncWithHttpInfo($search, $startDate, $endDate, $sort, $authType, $limit, $offset) ->then( function ($response) { return $response[0]; } ); } /** * Operation getAllExternalFeedsAsyncWithHttpInfo * * Fetch all external feeds * * @param string $search Can be used to filter records by search keyword on feed name (optional) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc) * @param string $authType Filter the records by `authType` of the feed. (optional) * @param int $limit Number of documents returned per page. (optional, default to 50) * @param int $offset Index of the first document on the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getAllExternalFeedsAsyncWithHttpInfo($search = null, $startDate = null, $endDate = null, $sort = 'desc', $authType = null, $limit = '50', $offset = '0') { $returnType = '\Brevo\Client\Model\GetAllExternalFeeds'; $request = $this->getAllExternalFeedsRequest($search, $startDate, $endDate, $sort, $authType, $limit, $offset); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getAllExternalFeeds' * * @param string $search Can be used to filter records by search keyword on feed name (optional) * @param \DateTime $startDate Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional) * @param \DateTime $endDate Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc) * @param string $authType Filter the records by `authType` of the feed. (optional) * @param int $limit Number of documents returned per page. (optional, default to 50) * @param int $offset Index of the first document on the page. (optional, default to 0) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getAllExternalFeedsRequest($search = null, $startDate = null, $endDate = null, $sort = 'desc', $authType = null, $limit = '50', $offset = '0') { if ($limit !== null && $limit > 500) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ExternalFeedsApi.getAllExternalFeeds, must be smaller than or equal to 500.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ExternalFeedsApi.getAllExternalFeeds, must be bigger than or equal to 0.'); } $resourcePath = '/feeds'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($search !== null) { $queryParams['search'] = ObjectSerializer::toQueryValue($search); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($authType !== null) { $queryParams['authType'] = ObjectSerializer::toQueryValue($authType); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getExternalFeedByUUID * * Get an external feed by UUID * * @param string $uuid UUID of the feed to fetch (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetExternalFeedByUUID */ public function getExternalFeedByUUID($uuid) { list($response) = $this->getExternalFeedByUUIDWithHttpInfo($uuid); return $response; } /** * Operation getExternalFeedByUUIDWithHttpInfo * * Get an external feed by UUID * * @param string $uuid UUID of the feed to fetch (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetExternalFeedByUUID, HTTP status code, HTTP response headers (array of strings) */ public function getExternalFeedByUUIDWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetExternalFeedByUUID'; $request = $this->getExternalFeedByUUIDRequest($uuid); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetExternalFeedByUUID', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getExternalFeedByUUIDAsync * * Get an external feed by UUID * * @param string $uuid UUID of the feed to fetch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getExternalFeedByUUIDAsync($uuid) { return $this->getExternalFeedByUUIDAsyncWithHttpInfo($uuid) ->then( function ($response) { return $response[0]; } ); } /** * Operation getExternalFeedByUUIDAsyncWithHttpInfo * * Get an external feed by UUID * * @param string $uuid UUID of the feed to fetch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getExternalFeedByUUIDAsyncWithHttpInfo($uuid) { $returnType = '\Brevo\Client\Model\GetExternalFeedByUUID'; $request = $this->getExternalFeedByUUIDRequest($uuid); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getExternalFeedByUUID' * * @param string $uuid UUID of the feed to fetch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getExternalFeedByUUIDRequest($uuid) { // verify the required parameter 'uuid' is set if ($uuid === null || (is_array($uuid) && count($uuid) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uuid when calling getExternalFeedByUUID' ); } $resourcePath = '/feeds/{uuid}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($uuid !== null) { $resourcePath = str_replace( '{' . 'uuid' . '}', ObjectSerializer::toPathValue($uuid), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateExternalFeed * * Update an external feed * * @param string $uuid UUID of the feed to update (required) * @param \Brevo\Client\Model\UpdateExternalFeed $updateExternalFeed Values to update a feed (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateExternalFeed($uuid, $updateExternalFeed) { $this->updateExternalFeedWithHttpInfo($uuid, $updateExternalFeed); } /** * Operation updateExternalFeedWithHttpInfo * * Update an external feed * * @param string $uuid UUID of the feed to update (required) * @param \Brevo\Client\Model\UpdateExternalFeed $updateExternalFeed Values to update a feed (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateExternalFeedWithHttpInfo($uuid, $updateExternalFeed) { $returnType = ''; $request = $this->updateExternalFeedRequest($uuid, $updateExternalFeed); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateExternalFeedAsync * * Update an external feed * * @param string $uuid UUID of the feed to update (required) * @param \Brevo\Client\Model\UpdateExternalFeed $updateExternalFeed Values to update a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateExternalFeedAsync($uuid, $updateExternalFeed) { return $this->updateExternalFeedAsyncWithHttpInfo($uuid, $updateExternalFeed) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateExternalFeedAsyncWithHttpInfo * * Update an external feed * * @param string $uuid UUID of the feed to update (required) * @param \Brevo\Client\Model\UpdateExternalFeed $updateExternalFeed Values to update a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateExternalFeedAsyncWithHttpInfo($uuid, $updateExternalFeed) { $returnType = ''; $request = $this->updateExternalFeedRequest($uuid, $updateExternalFeed); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateExternalFeed' * * @param string $uuid UUID of the feed to update (required) * @param \Brevo\Client\Model\UpdateExternalFeed $updateExternalFeed Values to update a feed (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateExternalFeedRequest($uuid, $updateExternalFeed) { // verify the required parameter 'uuid' is set if ($uuid === null || (is_array($uuid) && count($uuid) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $uuid when calling updateExternalFeed' ); } // verify the required parameter 'updateExternalFeed' is set if ($updateExternalFeed === null || (is_array($updateExternalFeed) && count($updateExternalFeed) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateExternalFeed when calling updateExternalFeed' ); } $resourcePath = '/feeds/{uuid}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($uuid !== null) { $resourcePath = str_replace( '{' . 'uuid' . '}', ObjectSerializer::toPathValue($uuid), $resourcePath ); } // body params $_tempBody = null; if (isset($updateExternalFeed)) { $_tempBody = $updateExternalFeed; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/CouponsApi.php 0000644 00000161316 15021222673 0012526 0 ustar 00 <?php /** * CouponsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * CouponsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CouponsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createCouponCollection * * Create а coupon collection * * @param \Brevo\Client\Model\CreateCouponCollection $createCouponCollection Values to create a coupon collection (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse2012 */ public function createCouponCollection($createCouponCollection) { list($response) = $this->createCouponCollectionWithHttpInfo($createCouponCollection); return $response; } /** * Operation createCouponCollectionWithHttpInfo * * Create а coupon collection * * @param \Brevo\Client\Model\CreateCouponCollection $createCouponCollection Values to create a coupon collection (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse2012, HTTP status code, HTTP response headers (array of strings) */ public function createCouponCollectionWithHttpInfo($createCouponCollection) { $returnType = '\Brevo\Client\Model\InlineResponse2012'; $request = $this->createCouponCollectionRequest($createCouponCollection); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse2012', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createCouponCollectionAsync * * Create а coupon collection * * @param \Brevo\Client\Model\CreateCouponCollection $createCouponCollection Values to create a coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createCouponCollectionAsync($createCouponCollection) { return $this->createCouponCollectionAsyncWithHttpInfo($createCouponCollection) ->then( function ($response) { return $response[0]; } ); } /** * Operation createCouponCollectionAsyncWithHttpInfo * * Create а coupon collection * * @param \Brevo\Client\Model\CreateCouponCollection $createCouponCollection Values to create a coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createCouponCollectionAsyncWithHttpInfo($createCouponCollection) { $returnType = '\Brevo\Client\Model\InlineResponse2012'; $request = $this->createCouponCollectionRequest($createCouponCollection); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createCouponCollection' * * @param \Brevo\Client\Model\CreateCouponCollection $createCouponCollection Values to create a coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createCouponCollectionRequest($createCouponCollection) { // verify the required parameter 'createCouponCollection' is set if ($createCouponCollection === null || (is_array($createCouponCollection) && count($createCouponCollection) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createCouponCollection when calling createCouponCollection' ); } $resourcePath = '/couponCollections'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createCouponCollection)) { $_tempBody = $createCouponCollection; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createCoupons * * Create coupons for a coupon collection * * @param \Brevo\Client\Model\CreateCoupons $createCoupons Values to create coupons (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createCoupons($createCoupons) { $this->createCouponsWithHttpInfo($createCoupons); } /** * Operation createCouponsWithHttpInfo * * Create coupons for a coupon collection * * @param \Brevo\Client\Model\CreateCoupons $createCoupons Values to create coupons (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createCouponsWithHttpInfo($createCoupons) { $returnType = ''; $request = $this->createCouponsRequest($createCoupons); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createCouponsAsync * * Create coupons for a coupon collection * * @param \Brevo\Client\Model\CreateCoupons $createCoupons Values to create coupons (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createCouponsAsync($createCoupons) { return $this->createCouponsAsyncWithHttpInfo($createCoupons) ->then( function ($response) { return $response[0]; } ); } /** * Operation createCouponsAsyncWithHttpInfo * * Create coupons for a coupon collection * * @param \Brevo\Client\Model\CreateCoupons $createCoupons Values to create coupons (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createCouponsAsyncWithHttpInfo($createCoupons) { $returnType = ''; $request = $this->createCouponsRequest($createCoupons); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createCoupons' * * @param \Brevo\Client\Model\CreateCoupons $createCoupons Values to create coupons (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createCouponsRequest($createCoupons) { // verify the required parameter 'createCoupons' is set if ($createCoupons === null || (is_array($createCoupons) && count($createCoupons) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createCoupons when calling createCoupons' ); } $resourcePath = '/coupons'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createCoupons)) { $_tempBody = $createCoupons; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getCouponCollection * * Get a coupon collection by id * * @param string $id Id of the collection to return (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetCouponCollection */ public function getCouponCollection($id) { list($response) = $this->getCouponCollectionWithHttpInfo($id); return $response; } /** * Operation getCouponCollectionWithHttpInfo * * Get a coupon collection by id * * @param string $id Id of the collection to return (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetCouponCollection, HTTP status code, HTTP response headers (array of strings) */ public function getCouponCollectionWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetCouponCollection'; $request = $this->getCouponCollectionRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetCouponCollection', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getCouponCollectionAsync * * Get a coupon collection by id * * @param string $id Id of the collection to return (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCouponCollectionAsync($id) { return $this->getCouponCollectionAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation getCouponCollectionAsyncWithHttpInfo * * Get a coupon collection by id * * @param string $id Id of the collection to return (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCouponCollectionAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetCouponCollection'; $request = $this->getCouponCollectionRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getCouponCollection' * * @param string $id Id of the collection to return (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getCouponCollectionRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling getCouponCollection' ); } $resourcePath = '/couponCollections/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getCouponCollections * * Get all your coupon collections * * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results by creation time in ascending/descending order (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetCouponCollection */ public function getCouponCollections($limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getCouponCollectionsWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getCouponCollectionsWithHttpInfo * * Get all your coupon collections * * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results by creation time in ascending/descending order (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetCouponCollection, HTTP status code, HTTP response headers (array of strings) */ public function getCouponCollectionsWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetCouponCollection'; $request = $this->getCouponCollectionsRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetCouponCollection', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getCouponCollectionsAsync * * Get all your coupon collections * * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results by creation time in ascending/descending order (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCouponCollectionsAsync($limit = '50', $offset = '0', $sort = 'desc') { return $this->getCouponCollectionsAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getCouponCollectionsAsyncWithHttpInfo * * Get all your coupon collections * * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results by creation time in ascending/descending order (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCouponCollectionsAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetCouponCollection'; $request = $this->getCouponCollectionsRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getCouponCollections' * * @param int $limit Number of documents returned per page (optional, default to 50) * @param int $offset Index of the first document on the page (optional, default to 0) * @param string $sort Sort the results by creation time in ascending/descending order (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getCouponCollectionsRequest($limit = '50', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling CouponsApi.getCouponCollections, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling CouponsApi.getCouponCollections, must be bigger than or equal to 0.'); } if ($offset !== null && $offset < 0) { throw new \InvalidArgumentException('invalid value for "$offset" when calling CouponsApi.getCouponCollections, must be bigger than or equal to 0.'); } $resourcePath = '/couponCollections'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateCouponCollection * * Update a coupon collection by id * * @param string $id Id of the collection to update (required) * @param \Brevo\Client\Model\UpdateCouponCollection $updateCouponCollection Values to update the coupon collection (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse2001 */ public function updateCouponCollection($id, $updateCouponCollection) { list($response) = $this->updateCouponCollectionWithHttpInfo($id, $updateCouponCollection); return $response; } /** * Operation updateCouponCollectionWithHttpInfo * * Update a coupon collection by id * * @param string $id Id of the collection to update (required) * @param \Brevo\Client\Model\UpdateCouponCollection $updateCouponCollection Values to update the coupon collection (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse2001, HTTP status code, HTTP response headers (array of strings) */ public function updateCouponCollectionWithHttpInfo($id, $updateCouponCollection) { $returnType = '\Brevo\Client\Model\InlineResponse2001'; $request = $this->updateCouponCollectionRequest($id, $updateCouponCollection); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse2001', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateCouponCollectionAsync * * Update a coupon collection by id * * @param string $id Id of the collection to update (required) * @param \Brevo\Client\Model\UpdateCouponCollection $updateCouponCollection Values to update the coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateCouponCollectionAsync($id, $updateCouponCollection) { return $this->updateCouponCollectionAsyncWithHttpInfo($id, $updateCouponCollection) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateCouponCollectionAsyncWithHttpInfo * * Update a coupon collection by id * * @param string $id Id of the collection to update (required) * @param \Brevo\Client\Model\UpdateCouponCollection $updateCouponCollection Values to update the coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateCouponCollectionAsyncWithHttpInfo($id, $updateCouponCollection) { $returnType = '\Brevo\Client\Model\InlineResponse2001'; $request = $this->updateCouponCollectionRequest($id, $updateCouponCollection); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateCouponCollection' * * @param string $id Id of the collection to update (required) * @param \Brevo\Client\Model\UpdateCouponCollection $updateCouponCollection Values to update the coupon collection (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateCouponCollectionRequest($id, $updateCouponCollection) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling updateCouponCollection' ); } // verify the required parameter 'updateCouponCollection' is set if ($updateCouponCollection === null || (is_array($updateCouponCollection) && count($updateCouponCollection) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateCouponCollection when calling updateCouponCollection' ); } $resourcePath = '/couponCollections/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($updateCouponCollection)) { $_tempBody = $updateCouponCollection; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/CompaniesApi.php 0000644 00000220673 15021222673 0013020 0 ustar 00 <?php /** * CompaniesApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * CompaniesApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompaniesApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation companiesAttributesGet * * Get company attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CompanyAttributes */ public function companiesAttributesGet() { list($response) = $this->companiesAttributesGetWithHttpInfo(); return $response; } /** * Operation companiesAttributesGetWithHttpInfo * * Get company attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CompanyAttributes, HTTP status code, HTTP response headers (array of strings) */ public function companiesAttributesGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\CompanyAttributes'; $request = $this->companiesAttributesGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CompanyAttributes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesAttributesGetAsync * * Get company attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesAttributesGetAsync() { return $this->companiesAttributesGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesAttributesGetAsyncWithHttpInfo * * Get company attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesAttributesGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\CompanyAttributes'; $request = $this->companiesAttributesGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesAttributesGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesAttributesGetRequest() { $resourcePath = '/companies/attributes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesGet * * Get all companies * * @param string $filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) * @param int $linkedContactsIds Filter by linked contacts ids (optional) * @param string $linkedDealsIds Filter by linked deals ids (optional) * @param int $page Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CompaniesList */ public function companiesGet($filters = null, $linkedContactsIds = null, $linkedDealsIds = null, $page = null, $limit = '50', $sort = null, $sortBy = null) { list($response) = $this->companiesGetWithHttpInfo($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy); return $response; } /** * Operation companiesGetWithHttpInfo * * Get all companies * * @param string $filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) * @param int $linkedContactsIds Filter by linked contacts ids (optional) * @param string $linkedDealsIds Filter by linked deals ids (optional) * @param int $page Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CompaniesList, HTTP status code, HTTP response headers (array of strings) */ public function companiesGetWithHttpInfo($filters = null, $linkedContactsIds = null, $linkedDealsIds = null, $page = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\CompaniesList'; $request = $this->companiesGetRequest($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CompaniesList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesGetAsync * * Get all companies * * @param string $filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) * @param int $linkedContactsIds Filter by linked contacts ids (optional) * @param string $linkedDealsIds Filter by linked deals ids (optional) * @param int $page Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesGetAsync($filters = null, $linkedContactsIds = null, $linkedDealsIds = null, $page = null, $limit = '50', $sort = null, $sortBy = null) { return $this->companiesGetAsyncWithHttpInfo($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesGetAsyncWithHttpInfo * * Get all companies * * @param string $filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) * @param int $linkedContactsIds Filter by linked contacts ids (optional) * @param string $linkedDealsIds Filter by linked deals ids (optional) * @param int $page Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesGetAsyncWithHttpInfo($filters = null, $linkedContactsIds = null, $linkedDealsIds = null, $page = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\CompaniesList'; $request = $this->companiesGetRequest($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesGet' * * @param string $filters Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} (optional) * @param int $linkedContactsIds Filter by linked contacts ids (optional) * @param string $linkedDealsIds Filter by linked deals ids (optional) * @param int $page Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesGetRequest($filters = null, $linkedContactsIds = null, $linkedDealsIds = null, $page = null, $limit = '50', $sort = null, $sortBy = null) { $resourcePath = '/companies'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($filters !== null) { $queryParams['filters'] = ObjectSerializer::toQueryValue($filters); } // query params if ($linkedContactsIds !== null) { $queryParams['linkedContactsIds'] = ObjectSerializer::toQueryValue($linkedContactsIds); } // query params if ($linkedDealsIds !== null) { $queryParams['linkedDealsIds'] = ObjectSerializer::toQueryValue($linkedDealsIds); } // query params if ($page !== null) { $queryParams['page'] = ObjectSerializer::toQueryValue($page); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($sortBy !== null) { $queryParams['sortBy'] = ObjectSerializer::toQueryValue($sortBy); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesIdDelete * * Delete a company * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function companiesIdDelete($id) { $this->companiesIdDeleteWithHttpInfo($id); } /** * Operation companiesIdDeleteWithHttpInfo * * Delete a company * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function companiesIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->companiesIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesIdDeleteAsync * * Delete a company * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdDeleteAsync($id) { return $this->companiesIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesIdDeleteAsyncWithHttpInfo * * Delete a company * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->companiesIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesIdDelete' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling companiesIdDelete' ); } $resourcePath = '/companies/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesIdGet * * Get a company * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Company */ public function companiesIdGet($id) { list($response) = $this->companiesIdGetWithHttpInfo($id); return $response; } /** * Operation companiesIdGetWithHttpInfo * * Get a company * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Company, HTTP status code, HTTP response headers (array of strings) */ public function companiesIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Company'; $request = $this->companiesIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Company', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesIdGetAsync * * Get a company * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdGetAsync($id) { return $this->companiesIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesIdGetAsyncWithHttpInfo * * Get a company * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Company'; $request = $this->companiesIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesIdGet' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling companiesIdGet' ); } $resourcePath = '/companies/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesIdPatch * * Update a company * * @param string $id id (required) * @param \Brevo\Client\Model\Body1 $body Updated company details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Company */ public function companiesIdPatch($id, $body) { list($response) = $this->companiesIdPatchWithHttpInfo($id, $body); return $response; } /** * Operation companiesIdPatchWithHttpInfo * * Update a company * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated company details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Company, HTTP status code, HTTP response headers (array of strings) */ public function companiesIdPatchWithHttpInfo($id, $body) { $returnType = '\Brevo\Client\Model\Company'; $request = $this->companiesIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Company', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesIdPatchAsync * * Update a company * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated company details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdPatchAsync($id, $body) { return $this->companiesIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesIdPatchAsyncWithHttpInfo * * Update a company * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated company details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesIdPatchAsyncWithHttpInfo($id, $body) { $returnType = '\Brevo\Client\Model\Company'; $request = $this->companiesIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body1 $body Updated company details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling companiesIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling companiesIdPatch' ); } $resourcePath = '/companies/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesLinkUnlinkIdPatch * * Link and Unlink company with contacts and deals * * @param string $id id (required) * @param \Brevo\Client\Model\Body2 $body Linked / Unlinked contacts and deals ids. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function companiesLinkUnlinkIdPatch($id, $body) { $this->companiesLinkUnlinkIdPatchWithHttpInfo($id, $body); } /** * Operation companiesLinkUnlinkIdPatchWithHttpInfo * * Link and Unlink company with contacts and deals * * @param string $id (required) * @param \Brevo\Client\Model\Body2 $body Linked / Unlinked contacts and deals ids. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function companiesLinkUnlinkIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->companiesLinkUnlinkIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesLinkUnlinkIdPatchAsync * * Link and Unlink company with contacts and deals * * @param string $id (required) * @param \Brevo\Client\Model\Body2 $body Linked / Unlinked contacts and deals ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesLinkUnlinkIdPatchAsync($id, $body) { return $this->companiesLinkUnlinkIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesLinkUnlinkIdPatchAsyncWithHttpInfo * * Link and Unlink company with contacts and deals * * @param string $id (required) * @param \Brevo\Client\Model\Body2 $body Linked / Unlinked contacts and deals ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesLinkUnlinkIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->companiesLinkUnlinkIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesLinkUnlinkIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body2 $body Linked / Unlinked contacts and deals ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesLinkUnlinkIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling companiesLinkUnlinkIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling companiesLinkUnlinkIdPatch' ); } $resourcePath = '/companies/link-unlink/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation companiesPost * * Create a company * * @param \Brevo\Client\Model\Body $body Company create data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse200 */ public function companiesPost($body) { list($response) = $this->companiesPostWithHttpInfo($body); return $response; } /** * Operation companiesPostWithHttpInfo * * Create a company * * @param \Brevo\Client\Model\Body $body Company create data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse200, HTTP status code, HTTP response headers (array of strings) */ public function companiesPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse200'; $request = $this->companiesPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse200', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation companiesPostAsync * * Create a company * * @param \Brevo\Client\Model\Body $body Company create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesPostAsync($body) { return $this->companiesPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation companiesPostAsyncWithHttpInfo * * Create a company * * @param \Brevo\Client\Model\Body $body Company create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function companiesPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse200'; $request = $this->companiesPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'companiesPost' * * @param \Brevo\Client\Model\Body $body Company create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function companiesPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling companiesPost' ); } $resourcePath = '/companies'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ListsApi.php 0000644 00000310424 15021222673 0012172 0 ustar 00 <?php /** * ListsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ListsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ListsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation addContactToList * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\PostContactInfo */ public function addContactToList($listId, $contactEmails) { list($response) = $this->addContactToListWithHttpInfo($listId, $contactEmails); return $response; } /** * Operation addContactToListWithHttpInfo * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\PostContactInfo, HTTP status code, HTTP response headers (array of strings) */ public function addContactToListWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->addContactToListRequest($listId, $contactEmails); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostContactInfo', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation addContactToListAsync * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addContactToListAsync($listId, $contactEmails) { return $this->addContactToListAsyncWithHttpInfo($listId, $contactEmails) ->then( function ($response) { return $response[0]; } ); } /** * Operation addContactToListAsyncWithHttpInfo * * Add existing contacts to a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function addContactToListAsyncWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->addContactToListRequest($listId, $contactEmails); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'addContactToList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\AddContactToList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function addContactToListRequest($listId, $contactEmails) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling addContactToList' ); } // verify the required parameter 'contactEmails' is set if ($contactEmails === null || (is_array($contactEmails) && count($contactEmails) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $contactEmails when calling addContactToList' ); } $resourcePath = '/contacts/lists/{listId}/contacts/add'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($contactEmails)) { $_tempBody = $contactEmails; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createList * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createList($createList) { list($response) = $this->createListWithHttpInfo($createList); return $response; } /** * Operation createListWithHttpInfo * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createListWithHttpInfo($createList) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createListRequest($createList); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createListAsync * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createListAsync($createList) { return $this->createListAsyncWithHttpInfo($createList) ->then( function ($response) { return $response[0]; } ); } /** * Operation createListAsyncWithHttpInfo * * Create a list * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createListAsyncWithHttpInfo($createList) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createListRequest($createList); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createList' * * @param \Brevo\Client\Model\CreateList $createList Values to create a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createListRequest($createList) { // verify the required parameter 'createList' is set if ($createList === null || (is_array($createList) && count($createList) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createList when calling createList' ); } $resourcePath = '/contacts/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createList)) { $_tempBody = $createList; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteList * * Delete a list * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteList($listId) { $this->deleteListWithHttpInfo($listId); } /** * Operation deleteListWithHttpInfo * * Delete a list * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteListWithHttpInfo($listId) { $returnType = ''; $request = $this->deleteListRequest($listId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteListAsync * * Delete a list * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteListAsync($listId) { return $this->deleteListAsyncWithHttpInfo($listId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteListAsyncWithHttpInfo * * Delete a list * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteListAsyncWithHttpInfo($listId) { $returnType = ''; $request = $this->deleteListRequest($listId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteList' * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteListRequest($listId) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling deleteList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getContactsFromList * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetContacts */ public function getContactsFromList($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getContactsFromListWithHttpInfo($listId, $modifiedSince, $limit, $offset, $sort); return $response; } /** * Operation getContactsFromListWithHttpInfo * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetContacts, HTTP status code, HTTP response headers (array of strings) */ public function getContactsFromListWithHttpInfo($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsFromListRequest($listId, $modifiedSince, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetContacts', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getContactsFromListAsync * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsFromListAsync($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { return $this->getContactsFromListAsyncWithHttpInfo($listId, $modifiedSince, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getContactsFromListAsyncWithHttpInfo * * Get contacts in a list * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getContactsFromListAsyncWithHttpInfo($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetContacts'; $request = $this->getContactsFromListRequest($listId, $modifiedSince, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getContactsFromList' * * @param int $listId Id of the list (required) * @param string $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getContactsFromListRequest($listId, $modifiedSince = null, $limit = '50', $offset = '0', $sort = 'desc') { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling getContactsFromList' ); } if ($limit !== null && $limit > 500) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ListsApi.getContactsFromList, must be smaller than or equal to 500.'); } $resourcePath = '/contacts/lists/{listId}/contacts'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($modifiedSince !== null) { $queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolderLists * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolderLists */ public function getFolderLists($folderId, $limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getFolderListsWithHttpInfo($folderId, $limit, $offset, $sort); return $response; } /** * Operation getFolderListsWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolderLists, HTTP status code, HTTP response headers (array of strings) */ public function getFolderListsWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolderLists', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFolderListsAsync * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsync($folderId, $limit = '10', $offset = '0', $sort = 'desc') { return $this->getFolderListsAsyncWithHttpInfo($folderId, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFolderListsAsyncWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsyncWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolderLists' * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFolderListsRequest($folderId, $limit = '10', $offset = '0', $sort = 'desc') { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling getFolderLists' ); } if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ListsApi.getFolderLists, must be smaller than or equal to 50.'); } $resourcePath = '/contacts/folders/{folderId}/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getList * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetExtendedList */ public function getList($listId) { list($response) = $this->getListWithHttpInfo($listId); return $response; } /** * Operation getListWithHttpInfo * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetExtendedList, HTTP status code, HTTP response headers (array of strings) */ public function getListWithHttpInfo($listId) { $returnType = '\Brevo\Client\Model\GetExtendedList'; $request = $this->getListRequest($listId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetExtendedList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getListAsync * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListAsync($listId) { return $this->getListAsyncWithHttpInfo($listId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getListAsyncWithHttpInfo * * Get a list's details * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListAsyncWithHttpInfo($listId) { $returnType = '\Brevo\Client\Model\GetExtendedList'; $request = $this->getListRequest($listId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getList' * * @param int $listId Id of the list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getListRequest($listId) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling getList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getLists * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetLists */ public function getLists($limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getListsWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getListsWithHttpInfo * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetLists, HTTP status code, HTTP response headers (array of strings) */ public function getListsWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetLists'; $request = $this->getListsRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetLists', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getListsAsync * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListsAsync($limit = '10', $offset = '0', $sort = 'desc') { return $this->getListsAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getListsAsyncWithHttpInfo * * Get all the lists * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getListsAsyncWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetLists'; $request = $this->getListsRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getLists' * * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getListsRequest($limit = '10', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ListsApi.getLists, must be smaller than or equal to 50.'); } $resourcePath = '/contacts/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation removeContactFromList * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\PostContactInfo */ public function removeContactFromList($listId, $contactEmails) { list($response) = $this->removeContactFromListWithHttpInfo($listId, $contactEmails); return $response; } /** * Operation removeContactFromListWithHttpInfo * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\PostContactInfo, HTTP status code, HTTP response headers (array of strings) */ public function removeContactFromListWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->removeContactFromListRequest($listId, $contactEmails); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostContactInfo', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation removeContactFromListAsync * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeContactFromListAsync($listId, $contactEmails) { return $this->removeContactFromListAsyncWithHttpInfo($listId, $contactEmails) ->then( function ($response) { return $response[0]; } ); } /** * Operation removeContactFromListAsyncWithHttpInfo * * Delete a contact from a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function removeContactFromListAsyncWithHttpInfo($listId, $contactEmails) { $returnType = '\Brevo\Client\Model\PostContactInfo'; $request = $this->removeContactFromListRequest($listId, $contactEmails); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'removeContactFromList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\RemoveContactFromList $contactEmails Emails addresses OR IDs of the contacts (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function removeContactFromListRequest($listId, $contactEmails) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling removeContactFromList' ); } // verify the required parameter 'contactEmails' is set if ($contactEmails === null || (is_array($contactEmails) && count($contactEmails) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $contactEmails when calling removeContactFromList' ); } $resourcePath = '/contacts/lists/{listId}/contacts/remove'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($contactEmails)) { $_tempBody = $contactEmails; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateList * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateList($listId, $updateList) { $this->updateListWithHttpInfo($listId, $updateList); } /** * Operation updateListWithHttpInfo * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateListWithHttpInfo($listId, $updateList) { $returnType = ''; $request = $this->updateListRequest($listId, $updateList); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateListAsync * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateListAsync($listId, $updateList) { return $this->updateListAsyncWithHttpInfo($listId, $updateList) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateListAsyncWithHttpInfo * * Update a list * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateListAsyncWithHttpInfo($listId, $updateList) { $returnType = ''; $request = $this->updateListRequest($listId, $updateList); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateList' * * @param int $listId Id of the list (required) * @param \Brevo\Client\Model\UpdateList $updateList Values to update a list (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateListRequest($listId, $updateList) { // verify the required parameter 'listId' is set if ($listId === null || (is_array($listId) && count($listId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $listId when calling updateList' ); } // verify the required parameter 'updateList' is set if ($updateList === null || (is_array($updateList) && count($updateList) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateList when calling updateList' ); } $resourcePath = '/contacts/lists/{listId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($listId !== null) { $resourcePath = str_replace( '{' . 'listId' . '}', ObjectSerializer::toPathValue($listId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateList)) { $_tempBody = $updateList; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/ProcessApi.php 0000644 00000061700 15021222673 0012512 0 ustar 00 <?php /** * ProcessApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * ProcessApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ProcessApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation getProcess * * Return the informations for a process * * @param int $processId Id of the process (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetProcess */ public function getProcess($processId) { list($response) = $this->getProcessWithHttpInfo($processId); return $response; } /** * Operation getProcessWithHttpInfo * * Return the informations for a process * * @param int $processId Id of the process (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetProcess, HTTP status code, HTTP response headers (array of strings) */ public function getProcessWithHttpInfo($processId) { $returnType = '\Brevo\Client\Model\GetProcess'; $request = $this->getProcessRequest($processId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetProcess', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getProcessAsync * * Return the informations for a process * * @param int $processId Id of the process (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProcessAsync($processId) { return $this->getProcessAsyncWithHttpInfo($processId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getProcessAsyncWithHttpInfo * * Return the informations for a process * * @param int $processId Id of the process (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProcessAsyncWithHttpInfo($processId) { $returnType = '\Brevo\Client\Model\GetProcess'; $request = $this->getProcessRequest($processId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getProcess' * * @param int $processId Id of the process (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getProcessRequest($processId) { // verify the required parameter 'processId' is set if ($processId === null || (is_array($processId) && count($processId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $processId when calling getProcess' ); } $resourcePath = '/processes/{processId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($processId !== null) { $resourcePath = str_replace( '{' . 'processId' . '}', ObjectSerializer::toPathValue($processId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getProcesses * * Return all the processes for your account * * @param int $limit Number limitation for the result returned (optional, default to 10) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetProcesses */ public function getProcesses($limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getProcessesWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getProcessesWithHttpInfo * * Return all the processes for your account * * @param int $limit Number limitation for the result returned (optional, default to 10) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetProcesses, HTTP status code, HTTP response headers (array of strings) */ public function getProcessesWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetProcesses'; $request = $this->getProcessesRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetProcesses', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getProcessesAsync * * Return all the processes for your account * * @param int $limit Number limitation for the result returned (optional, default to 10) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProcessesAsync($limit = '10', $offset = '0', $sort = 'desc') { return $this->getProcessesAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getProcessesAsyncWithHttpInfo * * Return all the processes for your account * * @param int $limit Number limitation for the result returned (optional, default to 10) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProcessesAsyncWithHttpInfo($limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetProcesses'; $request = $this->getProcessesRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getProcesses' * * @param int $limit Number limitation for the result returned (optional, default to 10) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getProcessesRequest($limit = '10', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ProcessApi.getProcesses, must be smaller than or equal to 50.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling ProcessApi.getProcesses, must be bigger than or equal to 0.'); } $resourcePath = '/processes'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/SMSCampaignsApi.php 0000644 00000324746 15021222673 0013375 0 ustar 00 <?php /** * SMSCampaignsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * SMSCampaignsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SMSCampaignsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createSmsCampaign * * Creates an SMS campaign * * @param \Brevo\Client\Model\CreateSmsCampaign $createSmsCampaign Values to create an SMS Campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createSmsCampaign($createSmsCampaign) { list($response) = $this->createSmsCampaignWithHttpInfo($createSmsCampaign); return $response; } /** * Operation createSmsCampaignWithHttpInfo * * Creates an SMS campaign * * @param \Brevo\Client\Model\CreateSmsCampaign $createSmsCampaign Values to create an SMS Campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createSmsCampaignWithHttpInfo($createSmsCampaign) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createSmsCampaignRequest($createSmsCampaign); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createSmsCampaignAsync * * Creates an SMS campaign * * @param \Brevo\Client\Model\CreateSmsCampaign $createSmsCampaign Values to create an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSmsCampaignAsync($createSmsCampaign) { return $this->createSmsCampaignAsyncWithHttpInfo($createSmsCampaign) ->then( function ($response) { return $response[0]; } ); } /** * Operation createSmsCampaignAsyncWithHttpInfo * * Creates an SMS campaign * * @param \Brevo\Client\Model\CreateSmsCampaign $createSmsCampaign Values to create an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSmsCampaignAsyncWithHttpInfo($createSmsCampaign) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createSmsCampaignRequest($createSmsCampaign); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createSmsCampaign' * * @param \Brevo\Client\Model\CreateSmsCampaign $createSmsCampaign Values to create an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createSmsCampaignRequest($createSmsCampaign) { // verify the required parameter 'createSmsCampaign' is set if ($createSmsCampaign === null || (is_array($createSmsCampaign) && count($createSmsCampaign) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createSmsCampaign when calling createSmsCampaign' ); } $resourcePath = '/smsCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createSmsCampaign)) { $_tempBody = $createSmsCampaign; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteSmsCampaign * * Delete an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteSmsCampaign($campaignId) { $this->deleteSmsCampaignWithHttpInfo($campaignId); } /** * Operation deleteSmsCampaignWithHttpInfo * * Delete an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteSmsCampaignWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteSmsCampaignRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteSmsCampaignAsync * * Delete an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSmsCampaignAsync($campaignId) { return $this->deleteSmsCampaignAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteSmsCampaignAsyncWithHttpInfo * * Delete an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSmsCampaignAsyncWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteSmsCampaignRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteSmsCampaign' * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteSmsCampaignRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling deleteSmsCampaign' ); } $resourcePath = '/smsCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSmsCampaign * * Get an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSmsCampaign */ public function getSmsCampaign($campaignId) { list($response) = $this->getSmsCampaignWithHttpInfo($campaignId); return $response; } /** * Operation getSmsCampaignWithHttpInfo * * Get an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSmsCampaign, HTTP status code, HTTP response headers (array of strings) */ public function getSmsCampaignWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetSmsCampaign'; $request = $this->getSmsCampaignRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSmsCampaign', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmsCampaignAsync * * Get an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsCampaignAsync($campaignId) { return $this->getSmsCampaignAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmsCampaignAsyncWithHttpInfo * * Get an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsCampaignAsyncWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetSmsCampaign'; $request = $this->getSmsCampaignRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmsCampaign' * * @param int $campaignId id of the SMS campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmsCampaignRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling getSmsCampaign' ); } $resourcePath = '/smsCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSmsCampaigns * * Returns the information for all your created SMS campaigns * * @param string $status Status of campaign. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number limitation for the result returned (optional, default to 500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSmsCampaigns */ public function getSmsCampaigns($status = null, $startDate = null, $endDate = null, $limit = '500', $offset = '0', $sort = 'desc') { list($response) = $this->getSmsCampaignsWithHttpInfo($status, $startDate, $endDate, $limit, $offset, $sort); return $response; } /** * Operation getSmsCampaignsWithHttpInfo * * Returns the information for all your created SMS campaigns * * @param string $status Status of campaign. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number limitation for the result returned (optional, default to 500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSmsCampaigns, HTTP status code, HTTP response headers (array of strings) */ public function getSmsCampaignsWithHttpInfo($status = null, $startDate = null, $endDate = null, $limit = '500', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmsCampaigns'; $request = $this->getSmsCampaignsRequest($status, $startDate, $endDate, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSmsCampaigns', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSmsCampaignsAsync * * Returns the information for all your created SMS campaigns * * @param string $status Status of campaign. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number limitation for the result returned (optional, default to 500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsCampaignsAsync($status = null, $startDate = null, $endDate = null, $limit = '500', $offset = '0', $sort = 'desc') { return $this->getSmsCampaignsAsyncWithHttpInfo($status, $startDate, $endDate, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSmsCampaignsAsyncWithHttpInfo * * Returns the information for all your created SMS campaigns * * @param string $status Status of campaign. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number limitation for the result returned (optional, default to 500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSmsCampaignsAsyncWithHttpInfo($status = null, $startDate = null, $endDate = null, $limit = '500', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetSmsCampaigns'; $request = $this->getSmsCampaignsRequest($status, $startDate, $endDate, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSmsCampaigns' * * @param string $status Status of campaign. (optional) * @param string $startDate Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param string $endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) * @param int $limit Number limitation for the result returned (optional, default to 500) * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSmsCampaignsRequest($status = null, $startDate = null, $endDate = null, $limit = '500', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 1000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling SMSCampaignsApi.getSmsCampaigns, must be smaller than or equal to 1000.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling SMSCampaignsApi.getSmsCampaigns, must be bigger than or equal to 0.'); } $resourcePath = '/smsCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($status !== null) { $queryParams['status'] = ObjectSerializer::toQueryValue($status); } // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation requestSmsRecipientExport * * Export an SMS campaign's recipients * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreatedProcessId */ public function requestSmsRecipientExport($campaignId, $recipientExport = null) { list($response) = $this->requestSmsRecipientExportWithHttpInfo($campaignId, $recipientExport); return $response; } /** * Operation requestSmsRecipientExportWithHttpInfo * * Export an SMS campaign's recipients * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ public function requestSmsRecipientExportWithHttpInfo($campaignId, $recipientExport = null) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->requestSmsRecipientExportRequest($campaignId, $recipientExport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreatedProcessId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation requestSmsRecipientExportAsync * * Export an SMS campaign's recipients * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function requestSmsRecipientExportAsync($campaignId, $recipientExport = null) { return $this->requestSmsRecipientExportAsyncWithHttpInfo($campaignId, $recipientExport) ->then( function ($response) { return $response[0]; } ); } /** * Operation requestSmsRecipientExportAsyncWithHttpInfo * * Export an SMS campaign's recipients * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function requestSmsRecipientExportAsyncWithHttpInfo($campaignId, $recipientExport = null) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->requestSmsRecipientExportRequest($campaignId, $recipientExport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'requestSmsRecipientExport' * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function requestSmsRecipientExportRequest($campaignId, $recipientExport = null) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling requestSmsRecipientExport' ); } $resourcePath = '/smsCampaigns/{campaignId}/exportRecipients'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($recipientExport)) { $_tempBody = $recipientExport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendSmsCampaignNow * * Send your SMS campaign immediately * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendSmsCampaignNow($campaignId) { $this->sendSmsCampaignNowWithHttpInfo($campaignId); } /** * Operation sendSmsCampaignNowWithHttpInfo * * Send your SMS campaign immediately * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendSmsCampaignNowWithHttpInfo($campaignId) { $returnType = ''; $request = $this->sendSmsCampaignNowRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 402: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendSmsCampaignNowAsync * * Send your SMS campaign immediately * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendSmsCampaignNowAsync($campaignId) { return $this->sendSmsCampaignNowAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendSmsCampaignNowAsyncWithHttpInfo * * Send your SMS campaign immediately * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendSmsCampaignNowAsyncWithHttpInfo($campaignId) { $returnType = ''; $request = $this->sendSmsCampaignNowRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendSmsCampaignNow' * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendSmsCampaignNowRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendSmsCampaignNow' ); } $resourcePath = '/smsCampaigns/{campaignId}/sendNow'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendSmsReport * * Send an SMS campaign's report * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendSmsReport($campaignId, $sendReport) { $this->sendSmsReportWithHttpInfo($campaignId, $sendReport); } /** * Operation sendSmsReportWithHttpInfo * * Send an SMS campaign's report * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendSmsReportWithHttpInfo($campaignId, $sendReport) { $returnType = ''; $request = $this->sendSmsReportRequest($campaignId, $sendReport); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendSmsReportAsync * * Send an SMS campaign's report * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendSmsReportAsync($campaignId, $sendReport) { return $this->sendSmsReportAsyncWithHttpInfo($campaignId, $sendReport) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendSmsReportAsyncWithHttpInfo * * Send an SMS campaign's report * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendSmsReportAsyncWithHttpInfo($campaignId, $sendReport) { $returnType = ''; $request = $this->sendSmsReportRequest($campaignId, $sendReport); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendSmsReport' * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\SendReport $sendReport Values for send a report (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendSmsReportRequest($campaignId, $sendReport) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendSmsReport' ); } // verify the required parameter 'sendReport' is set if ($sendReport === null || (is_array($sendReport) && count($sendReport) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $sendReport when calling sendSmsReport' ); } $resourcePath = '/smsCampaigns/{campaignId}/sendReport'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($sendReport)) { $_tempBody = $sendReport; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendTestSms * * Send a test SMS campaign * * @param int $campaignId Id of the SMS campaign (required) * @param \Brevo\Client\Model\SendTestSms $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendTestSms($campaignId, $phoneNumber) { $this->sendTestSmsWithHttpInfo($campaignId, $phoneNumber); } /** * Operation sendTestSmsWithHttpInfo * * Send a test SMS campaign * * @param int $campaignId Id of the SMS campaign (required) * @param \Brevo\Client\Model\SendTestSms $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendTestSmsWithHttpInfo($campaignId, $phoneNumber) { $returnType = ''; $request = $this->sendTestSmsRequest($campaignId, $phoneNumber); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\PostSendSmsTestFailed', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendTestSmsAsync * * Send a test SMS campaign * * @param int $campaignId Id of the SMS campaign (required) * @param \Brevo\Client\Model\SendTestSms $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestSmsAsync($campaignId, $phoneNumber) { return $this->sendTestSmsAsyncWithHttpInfo($campaignId, $phoneNumber) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendTestSmsAsyncWithHttpInfo * * Send a test SMS campaign * * @param int $campaignId Id of the SMS campaign (required) * @param \Brevo\Client\Model\SendTestSms $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendTestSmsAsyncWithHttpInfo($campaignId, $phoneNumber) { $returnType = ''; $request = $this->sendTestSmsRequest($campaignId, $phoneNumber); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendTestSms' * * @param int $campaignId Id of the SMS campaign (required) * @param \Brevo\Client\Model\SendTestSms $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendTestSmsRequest($campaignId, $phoneNumber) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling sendTestSms' ); } // verify the required parameter 'phoneNumber' is set if ($phoneNumber === null || (is_array($phoneNumber) && count($phoneNumber) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $phoneNumber when calling sendTestSms' ); } $resourcePath = '/smsCampaigns/{campaignId}/sendTest'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($phoneNumber)) { $_tempBody = $phoneNumber; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateSmsCampaign * * Update an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * @param \Brevo\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateSmsCampaign($campaignId, $updateSmsCampaign) { $this->updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign); } /** * Operation updateSmsCampaignWithHttpInfo * * Update an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * @param \Brevo\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign) { $returnType = ''; $request = $this->updateSmsCampaignRequest($campaignId, $updateSmsCampaign); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateSmsCampaignAsync * * Update an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * @param \Brevo\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmsCampaignAsync($campaignId, $updateSmsCampaign) { return $this->updateSmsCampaignAsyncWithHttpInfo($campaignId, $updateSmsCampaign) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateSmsCampaignAsyncWithHttpInfo * * Update an SMS campaign * * @param int $campaignId id of the SMS campaign (required) * @param \Brevo\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmsCampaignAsyncWithHttpInfo($campaignId, $updateSmsCampaign) { $returnType = ''; $request = $this->updateSmsCampaignRequest($campaignId, $updateSmsCampaign); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateSmsCampaign' * * @param int $campaignId id of the SMS campaign (required) * @param \Brevo\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateSmsCampaignRequest($campaignId, $updateSmsCampaign) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling updateSmsCampaign' ); } // verify the required parameter 'updateSmsCampaign' is set if ($updateSmsCampaign === null || (is_array($updateSmsCampaign) && count($updateSmsCampaign) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateSmsCampaign when calling updateSmsCampaign' ); } $resourcePath = '/smsCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateSmsCampaign)) { $_tempBody = $updateSmsCampaign; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateSmsCampaignStatus * * Update a campaign's status * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateSmsCampaignStatus($campaignId, $status) { $this->updateSmsCampaignStatusWithHttpInfo($campaignId, $status); } /** * Operation updateSmsCampaignStatusWithHttpInfo * * Update a campaign's status * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateSmsCampaignStatusWithHttpInfo($campaignId, $status) { $returnType = ''; $request = $this->updateSmsCampaignStatusRequest($campaignId, $status); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateSmsCampaignStatusAsync * * Update a campaign's status * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmsCampaignStatusAsync($campaignId, $status) { return $this->updateSmsCampaignStatusAsyncWithHttpInfo($campaignId, $status) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateSmsCampaignStatusAsyncWithHttpInfo * * Update a campaign's status * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSmsCampaignStatusAsyncWithHttpInfo($campaignId, $status) { $returnType = ''; $request = $this->updateSmsCampaignStatusRequest($campaignId, $status); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateSmsCampaignStatus' * * @param int $campaignId id of the campaign (required) * @param \Brevo\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateSmsCampaignStatusRequest($campaignId, $status) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling updateSmsCampaignStatus' ); } // verify the required parameter 'status' is set if ($status === null || (is_array($status) && count($status) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $status when calling updateSmsCampaignStatus' ); } $resourcePath = '/smsCampaigns/{campaignId}/status'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($status)) { $_tempBody = $status; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/SendersApi.php 0000644 00000205750 15021222673 0012504 0 ustar 00 <?php /** * SendersApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * SendersApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendersApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createSender * * Create a new sender * * @param \Brevo\Client\Model\CreateSender $sender sender's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateSenderModel */ public function createSender($sender = null) { list($response) = $this->createSenderWithHttpInfo($sender); return $response; } /** * Operation createSenderWithHttpInfo * * Create a new sender * * @param \Brevo\Client\Model\CreateSender $sender sender's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateSenderModel, HTTP status code, HTTP response headers (array of strings) */ public function createSenderWithHttpInfo($sender = null) { $returnType = '\Brevo\Client\Model\CreateSenderModel'; $request = $this->createSenderRequest($sender); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateSenderModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createSenderAsync * * Create a new sender * * @param \Brevo\Client\Model\CreateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSenderAsync($sender = null) { return $this->createSenderAsyncWithHttpInfo($sender) ->then( function ($response) { return $response[0]; } ); } /** * Operation createSenderAsyncWithHttpInfo * * Create a new sender * * @param \Brevo\Client\Model\CreateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createSenderAsyncWithHttpInfo($sender = null) { $returnType = '\Brevo\Client\Model\CreateSenderModel'; $request = $this->createSenderRequest($sender); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createSender' * * @param \Brevo\Client\Model\CreateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createSenderRequest($sender = null) { $resourcePath = '/senders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($sender)) { $_tempBody = $sender; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteSender * * Delete a sender * * @param int $senderId Id of the sender (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteSender($senderId) { $this->deleteSenderWithHttpInfo($senderId); } /** * Operation deleteSenderWithHttpInfo * * Delete a sender * * @param int $senderId Id of the sender (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteSenderWithHttpInfo($senderId) { $returnType = ''; $request = $this->deleteSenderRequest($senderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteSenderAsync * * Delete a sender * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSenderAsync($senderId) { return $this->deleteSenderAsyncWithHttpInfo($senderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteSenderAsyncWithHttpInfo * * Delete a sender * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteSenderAsyncWithHttpInfo($senderId) { $returnType = ''; $request = $this->deleteSenderRequest($senderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteSender' * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteSenderRequest($senderId) { // verify the required parameter 'senderId' is set if ($senderId === null || (is_array($senderId) && count($senderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $senderId when calling deleteSender' ); } $resourcePath = '/senders/{senderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($senderId !== null) { $resourcePath = str_replace( '{' . 'senderId' . '}', ObjectSerializer::toPathValue($senderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getIps * * Get all the dedicated IPs for your account * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetIps */ public function getIps() { list($response) = $this->getIpsWithHttpInfo(); return $response; } /** * Operation getIpsWithHttpInfo * * Get all the dedicated IPs for your account * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetIps, HTTP status code, HTTP response headers (array of strings) */ public function getIpsWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetIps'; $request = $this->getIpsRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetIps', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getIpsAsync * * Get all the dedicated IPs for your account * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getIpsAsync() { return $this->getIpsAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getIpsAsyncWithHttpInfo * * Get all the dedicated IPs for your account * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getIpsAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetIps'; $request = $this->getIpsRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getIps' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getIpsRequest() { $resourcePath = '/senders/ips'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getIpsFromSender * * Get all the dedicated IPs for a sender * * @param int $senderId Id of the sender (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetIpsFromSender */ public function getIpsFromSender($senderId) { list($response) = $this->getIpsFromSenderWithHttpInfo($senderId); return $response; } /** * Operation getIpsFromSenderWithHttpInfo * * Get all the dedicated IPs for a sender * * @param int $senderId Id of the sender (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetIpsFromSender, HTTP status code, HTTP response headers (array of strings) */ public function getIpsFromSenderWithHttpInfo($senderId) { $returnType = '\Brevo\Client\Model\GetIpsFromSender'; $request = $this->getIpsFromSenderRequest($senderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetIpsFromSender', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getIpsFromSenderAsync * * Get all the dedicated IPs for a sender * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getIpsFromSenderAsync($senderId) { return $this->getIpsFromSenderAsyncWithHttpInfo($senderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getIpsFromSenderAsyncWithHttpInfo * * Get all the dedicated IPs for a sender * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getIpsFromSenderAsyncWithHttpInfo($senderId) { $returnType = '\Brevo\Client\Model\GetIpsFromSender'; $request = $this->getIpsFromSenderRequest($senderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getIpsFromSender' * * @param int $senderId Id of the sender (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getIpsFromSenderRequest($senderId) { // verify the required parameter 'senderId' is set if ($senderId === null || (is_array($senderId) && count($senderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $senderId when calling getIpsFromSender' ); } $resourcePath = '/senders/{senderId}/ips'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($senderId !== null) { $resourcePath = str_replace( '{' . 'senderId' . '}', ObjectSerializer::toPathValue($senderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getSenders * * Get the list of all your senders * * @param string $ip Filter your senders for a specific ip (available for dedicated IP usage only) (optional) * @param string $domain Filter your senders for a specific domain (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetSendersList */ public function getSenders($ip = null, $domain = null) { list($response) = $this->getSendersWithHttpInfo($ip, $domain); return $response; } /** * Operation getSendersWithHttpInfo * * Get the list of all your senders * * @param string $ip Filter your senders for a specific ip (available for dedicated IP usage only) (optional) * @param string $domain Filter your senders for a specific domain (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetSendersList, HTTP status code, HTTP response headers (array of strings) */ public function getSendersWithHttpInfo($ip = null, $domain = null) { $returnType = '\Brevo\Client\Model\GetSendersList'; $request = $this->getSendersRequest($ip, $domain); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetSendersList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getSendersAsync * * Get the list of all your senders * * @param string $ip Filter your senders for a specific ip (available for dedicated IP usage only) (optional) * @param string $domain Filter your senders for a specific domain (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSendersAsync($ip = null, $domain = null) { return $this->getSendersAsyncWithHttpInfo($ip, $domain) ->then( function ($response) { return $response[0]; } ); } /** * Operation getSendersAsyncWithHttpInfo * * Get the list of all your senders * * @param string $ip Filter your senders for a specific ip (available for dedicated IP usage only) (optional) * @param string $domain Filter your senders for a specific domain (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getSendersAsyncWithHttpInfo($ip = null, $domain = null) { $returnType = '\Brevo\Client\Model\GetSendersList'; $request = $this->getSendersRequest($ip, $domain); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getSenders' * * @param string $ip Filter your senders for a specific ip (available for dedicated IP usage only) (optional) * @param string $domain Filter your senders for a specific domain (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getSendersRequest($ip = null, $domain = null) { $resourcePath = '/senders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($ip !== null) { $queryParams['ip'] = ObjectSerializer::toQueryValue($ip); } // query params if ($domain !== null) { $queryParams['domain'] = ObjectSerializer::toQueryValue($domain); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateSender * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\UpdateSender $sender sender's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateSender($senderId, $sender = null) { $this->updateSenderWithHttpInfo($senderId, $sender); } /** * Operation updateSenderWithHttpInfo * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\UpdateSender $sender sender's name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateSenderWithHttpInfo($senderId, $sender = null) { $returnType = ''; $request = $this->updateSenderRequest($senderId, $sender); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateSenderAsync * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\UpdateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSenderAsync($senderId, $sender = null) { return $this->updateSenderAsyncWithHttpInfo($senderId, $sender) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateSenderAsyncWithHttpInfo * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\UpdateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateSenderAsyncWithHttpInfo($senderId, $sender = null) { $returnType = ''; $request = $this->updateSenderRequest($senderId, $sender); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateSender' * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\UpdateSender $sender sender's name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateSenderRequest($senderId, $sender = null) { // verify the required parameter 'senderId' is set if ($senderId === null || (is_array($senderId) && count($senderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $senderId when calling updateSender' ); } $resourcePath = '/senders/{senderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($senderId !== null) { $resourcePath = str_replace( '{' . 'senderId' . '}', ObjectSerializer::toPathValue($senderId), $resourcePath ); } // body params $_tempBody = null; if (isset($sender)) { $_tempBody = $sender; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation validateSenderByOTP * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\Otp $otp otp (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function validateSenderByOTP($senderId, $otp = null) { $this->validateSenderByOTPWithHttpInfo($senderId, $otp); } /** * Operation validateSenderByOTPWithHttpInfo * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\Otp $otp otp (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function validateSenderByOTPWithHttpInfo($senderId, $otp = null) { $returnType = ''; $request = $this->validateSenderByOTPRequest($senderId, $otp); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation validateSenderByOTPAsync * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\Otp $otp otp (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function validateSenderByOTPAsync($senderId, $otp = null) { return $this->validateSenderByOTPAsyncWithHttpInfo($senderId, $otp) ->then( function ($response) { return $response[0]; } ); } /** * Operation validateSenderByOTPAsyncWithHttpInfo * * Update a sender * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\Otp $otp otp (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function validateSenderByOTPAsyncWithHttpInfo($senderId, $otp = null) { $returnType = ''; $request = $this->validateSenderByOTPRequest($senderId, $otp); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'validateSenderByOTP' * * @param int $senderId Id of the sender (required) * @param \Brevo\Client\Model\Otp $otp otp (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function validateSenderByOTPRequest($senderId, $otp = null) { // verify the required parameter 'senderId' is set if ($senderId === null || (is_array($senderId) && count($senderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $senderId when calling validateSenderByOTP' ); } $resourcePath = '/senders/{senderId}/validate'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($senderId !== null) { $resourcePath = str_replace( '{' . 'senderId' . '}', ObjectSerializer::toPathValue($senderId), $resourcePath ); } // body params $_tempBody = null; if (isset($otp)) { $_tempBody = $otp; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/FoldersApi.php 0000644 00000201421 15021222673 0012466 0 ustar 00 <?php /** * FoldersApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * FoldersApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FoldersApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createFolder * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createFolder($createFolder) { list($response) = $this->createFolderWithHttpInfo($createFolder); return $response; } /** * Operation createFolderWithHttpInfo * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createFolderWithHttpInfo($createFolder) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createFolderRequest($createFolder); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createFolderAsync * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createFolderAsync($createFolder) { return $this->createFolderAsyncWithHttpInfo($createFolder) ->then( function ($response) { return $response[0]; } ); } /** * Operation createFolderAsyncWithHttpInfo * * Create a folder * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createFolderAsyncWithHttpInfo($createFolder) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createFolderRequest($createFolder); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createFolder' * * @param \Brevo\Client\Model\CreateUpdateFolder $createFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createFolderRequest($createFolder) { // verify the required parameter 'createFolder' is set if ($createFolder === null || (is_array($createFolder) && count($createFolder) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createFolder when calling createFolder' ); } $resourcePath = '/contacts/folders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createFolder)) { $_tempBody = $createFolder; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteFolder * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteFolder($folderId) { $this->deleteFolderWithHttpInfo($folderId); } /** * Operation deleteFolderWithHttpInfo * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteFolderWithHttpInfo($folderId) { $returnType = ''; $request = $this->deleteFolderRequest($folderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteFolderAsync * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteFolderAsync($folderId) { return $this->deleteFolderAsyncWithHttpInfo($folderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteFolderAsyncWithHttpInfo * * Delete a folder (and all its lists) * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteFolderAsyncWithHttpInfo($folderId) { $returnType = ''; $request = $this->deleteFolderRequest($folderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteFolder' * * @param int $folderId Id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteFolderRequest($folderId) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling deleteFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolder * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolder */ public function getFolder($folderId) { list($response) = $this->getFolderWithHttpInfo($folderId); return $response; } /** * Operation getFolderWithHttpInfo * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolder, HTTP status code, HTTP response headers (array of strings) */ public function getFolderWithHttpInfo($folderId) { $returnType = '\Brevo\Client\Model\GetFolder'; $request = $this->getFolderRequest($folderId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolder', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFolderAsync * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderAsync($folderId) { return $this->getFolderAsyncWithHttpInfo($folderId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFolderAsyncWithHttpInfo * * Returns a folder's details * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderAsyncWithHttpInfo($folderId) { $returnType = '\Brevo\Client\Model\GetFolder'; $request = $this->getFolderRequest($folderId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolder' * * @param int $folderId id of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFolderRequest($folderId) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling getFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolderLists * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolderLists */ public function getFolderLists($folderId, $limit = '10', $offset = '0', $sort = 'desc') { list($response) = $this->getFolderListsWithHttpInfo($folderId, $limit, $offset, $sort); return $response; } /** * Operation getFolderListsWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolderLists, HTTP status code, HTTP response headers (array of strings) */ public function getFolderListsWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolderLists', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFolderListsAsync * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsync($folderId, $limit = '10', $offset = '0', $sort = 'desc') { return $this->getFolderListsAsyncWithHttpInfo($folderId, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFolderListsAsyncWithHttpInfo * * Get lists in a folder * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFolderListsAsyncWithHttpInfo($folderId, $limit = '10', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolderLists'; $request = $this->getFolderListsRequest($folderId, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolderLists' * * @param int $folderId Id of the folder (required) * @param int $limit Number of documents per page (optional, default to 10) * @param int $offset Index of the first document of the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFolderListsRequest($folderId, $limit = '10', $offset = '0', $sort = 'desc') { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling getFolderLists' ); } if ($limit !== null && $limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling FoldersApi.getFolderLists, must be smaller than or equal to 50.'); } $resourcePath = '/contacts/folders/{folderId}/lists'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getFolders * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetFolders */ public function getFolders($limit, $offset, $sort = 'desc') { list($response) = $this->getFoldersWithHttpInfo($limit, $offset, $sort); return $response; } /** * Operation getFoldersWithHttpInfo * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetFolders, HTTP status code, HTTP response headers (array of strings) */ public function getFoldersWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolders'; $request = $this->getFoldersRequest($limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetFolders', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getFoldersAsync * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFoldersAsync($limit, $offset, $sort = 'desc') { return $this->getFoldersAsyncWithHttpInfo($limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getFoldersAsyncWithHttpInfo * * Get all folders * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getFoldersAsyncWithHttpInfo($limit, $offset, $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetFolders'; $request = $this->getFoldersRequest($limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getFolders' * * @param int $limit Number of documents per page (required) * @param int $offset Index of the first document of the page (required) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getFoldersRequest($limit, $offset, $sort = 'desc') { // verify the required parameter 'limit' is set if ($limit === null || (is_array($limit) && count($limit) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $limit when calling getFolders' ); } if ($limit > 50) { throw new \InvalidArgumentException('invalid value for "$limit" when calling FoldersApi.getFolders, must be smaller than or equal to 50.'); } // verify the required parameter 'offset' is set if ($offset === null || (is_array($offset) && count($offset) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $offset when calling getFolders' ); } $resourcePath = '/contacts/folders'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateFolder * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateFolder($folderId, $updateFolder) { $this->updateFolderWithHttpInfo($folderId, $updateFolder); } /** * Operation updateFolderWithHttpInfo * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateFolderWithHttpInfo($folderId, $updateFolder) { $returnType = ''; $request = $this->updateFolderRequest($folderId, $updateFolder); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateFolderAsync * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateFolderAsync($folderId, $updateFolder) { return $this->updateFolderAsyncWithHttpInfo($folderId, $updateFolder) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateFolderAsyncWithHttpInfo * * Update a folder * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateFolderAsyncWithHttpInfo($folderId, $updateFolder) { $returnType = ''; $request = $this->updateFolderRequest($folderId, $updateFolder); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateFolder' * * @param int $folderId Id of the folder (required) * @param \Brevo\Client\Model\CreateUpdateFolder $updateFolder Name of the folder (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateFolderRequest($folderId, $updateFolder) { // verify the required parameter 'folderId' is set if ($folderId === null || (is_array($folderId) && count($folderId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $folderId when calling updateFolder' ); } // verify the required parameter 'updateFolder' is set if ($updateFolder === null || (is_array($updateFolder) && count($updateFolder) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateFolder when calling updateFolder' ); } $resourcePath = '/contacts/folders/{folderId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($folderId !== null) { $resourcePath = str_replace( '{' . 'folderId' . '}', ObjectSerializer::toPathValue($folderId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateFolder)) { $_tempBody = $updateFolder; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/EcommerceApi.php 0000644 00000353274 15021222673 0013005 0 ustar 00 <?php /** * EcommerceApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * EcommerceApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EcommerceApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createBatchOrder * * Create orders in batch * * @param \Brevo\Client\Model\OrderBatch $orderBatch orderBatch (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createBatchOrder($orderBatch) { $this->createBatchOrderWithHttpInfo($orderBatch); } /** * Operation createBatchOrderWithHttpInfo * * Create orders in batch * * @param \Brevo\Client\Model\OrderBatch $orderBatch (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createBatchOrderWithHttpInfo($orderBatch) { $returnType = ''; $request = $this->createBatchOrderRequest($orderBatch); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createBatchOrderAsync * * Create orders in batch * * @param \Brevo\Client\Model\OrderBatch $orderBatch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createBatchOrderAsync($orderBatch) { return $this->createBatchOrderAsyncWithHttpInfo($orderBatch) ->then( function ($response) { return $response[0]; } ); } /** * Operation createBatchOrderAsyncWithHttpInfo * * Create orders in batch * * @param \Brevo\Client\Model\OrderBatch $orderBatch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createBatchOrderAsyncWithHttpInfo($orderBatch) { $returnType = ''; $request = $this->createBatchOrderRequest($orderBatch); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createBatchOrder' * * @param \Brevo\Client\Model\OrderBatch $orderBatch (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createBatchOrderRequest($orderBatch) { // verify the required parameter 'orderBatch' is set if ($orderBatch === null || (is_array($orderBatch) && count($orderBatch) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $orderBatch when calling createBatchOrder' ); } $resourcePath = '/orders/status/batch'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($orderBatch)) { $_tempBody = $orderBatch; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createOrder * * Managing the status of the order * * @param \Brevo\Client\Model\Order $order order (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function createOrder($order) { $this->createOrderWithHttpInfo($order); } /** * Operation createOrderWithHttpInfo * * Managing the status of the order * * @param \Brevo\Client\Model\Order $order (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function createOrderWithHttpInfo($order) { $returnType = ''; $request = $this->createOrderRequest($order); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createOrderAsync * * Managing the status of the order * * @param \Brevo\Client\Model\Order $order (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createOrderAsync($order) { return $this->createOrderAsyncWithHttpInfo($order) ->then( function ($response) { return $response[0]; } ); } /** * Operation createOrderAsyncWithHttpInfo * * Managing the status of the order * * @param \Brevo\Client\Model\Order $order (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createOrderAsyncWithHttpInfo($order) { $returnType = ''; $request = $this->createOrderRequest($order); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createOrder' * * @param \Brevo\Client\Model\Order $order (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createOrderRequest($order) { // verify the required parameter 'order' is set if ($order === null || (is_array($order) && count($order) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $order when calling createOrder' ); } $resourcePath = '/orders/status'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($order)) { $_tempBody = $order; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createUpdateBatchCategory * * Create categories in batch * * @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateUpdateBatchCategoryModel */ public function createUpdateBatchCategory($createUpdateBatchCategory) { list($response) = $this->createUpdateBatchCategoryWithHttpInfo($createUpdateBatchCategory); return $response; } /** * Operation createUpdateBatchCategoryWithHttpInfo * * Create categories in batch * * @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateUpdateBatchCategoryModel, HTTP status code, HTTP response headers (array of strings) */ public function createUpdateBatchCategoryWithHttpInfo($createUpdateBatchCategory) { $returnType = '\Brevo\Client\Model\CreateUpdateBatchCategoryModel'; $request = $this->createUpdateBatchCategoryRequest($createUpdateBatchCategory); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateUpdateBatchCategoryModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createUpdateBatchCategoryAsync * * Create categories in batch * * @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateBatchCategoryAsync($createUpdateBatchCategory) { return $this->createUpdateBatchCategoryAsyncWithHttpInfo($createUpdateBatchCategory) ->then( function ($response) { return $response[0]; } ); } /** * Operation createUpdateBatchCategoryAsyncWithHttpInfo * * Create categories in batch * * @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateBatchCategoryAsyncWithHttpInfo($createUpdateBatchCategory) { $returnType = '\Brevo\Client\Model\CreateUpdateBatchCategoryModel'; $request = $this->createUpdateBatchCategoryRequest($createUpdateBatchCategory); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createUpdateBatchCategory' * * @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createUpdateBatchCategoryRequest($createUpdateBatchCategory) { // verify the required parameter 'createUpdateBatchCategory' is set if ($createUpdateBatchCategory === null || (is_array($createUpdateBatchCategory) && count($createUpdateBatchCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createUpdateBatchCategory when calling createUpdateBatchCategory' ); } $resourcePath = '/categories/batch'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createUpdateBatchCategory)) { $_tempBody = $createUpdateBatchCategory; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createUpdateBatchProducts * * Create products in batch * * @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateUpdateBatchProductsModel */ public function createUpdateBatchProducts($createUpdateBatchProducts) { list($response) = $this->createUpdateBatchProductsWithHttpInfo($createUpdateBatchProducts); return $response; } /** * Operation createUpdateBatchProductsWithHttpInfo * * Create products in batch * * @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateUpdateBatchProductsModel, HTTP status code, HTTP response headers (array of strings) */ public function createUpdateBatchProductsWithHttpInfo($createUpdateBatchProducts) { $returnType = '\Brevo\Client\Model\CreateUpdateBatchProductsModel'; $request = $this->createUpdateBatchProductsRequest($createUpdateBatchProducts); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateUpdateBatchProductsModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createUpdateBatchProductsAsync * * Create products in batch * * @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateBatchProductsAsync($createUpdateBatchProducts) { return $this->createUpdateBatchProductsAsyncWithHttpInfo($createUpdateBatchProducts) ->then( function ($response) { return $response[0]; } ); } /** * Operation createUpdateBatchProductsAsyncWithHttpInfo * * Create products in batch * * @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateBatchProductsAsyncWithHttpInfo($createUpdateBatchProducts) { $returnType = '\Brevo\Client\Model\CreateUpdateBatchProductsModel'; $request = $this->createUpdateBatchProductsRequest($createUpdateBatchProducts); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createUpdateBatchProducts' * * @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createUpdateBatchProductsRequest($createUpdateBatchProducts) { // verify the required parameter 'createUpdateBatchProducts' is set if ($createUpdateBatchProducts === null || (is_array($createUpdateBatchProducts) && count($createUpdateBatchProducts) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createUpdateBatchProducts when calling createUpdateBatchProducts' ); } $resourcePath = '/products/batch'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createUpdateBatchProducts)) { $_tempBody = $createUpdateBatchProducts; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createUpdateCategory * * Create/Update a category * * @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateCategoryModel */ public function createUpdateCategory($createUpdateCategory) { list($response) = $this->createUpdateCategoryWithHttpInfo($createUpdateCategory); return $response; } /** * Operation createUpdateCategoryWithHttpInfo * * Create/Update a category * * @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateCategoryModel, HTTP status code, HTTP response headers (array of strings) */ public function createUpdateCategoryWithHttpInfo($createUpdateCategory) { $returnType = '\Brevo\Client\Model\CreateCategoryModel'; $request = $this->createUpdateCategoryRequest($createUpdateCategory); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateCategoryModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createUpdateCategoryAsync * * Create/Update a category * * @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateCategoryAsync($createUpdateCategory) { return $this->createUpdateCategoryAsyncWithHttpInfo($createUpdateCategory) ->then( function ($response) { return $response[0]; } ); } /** * Operation createUpdateCategoryAsyncWithHttpInfo * * Create/Update a category * * @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateCategoryAsyncWithHttpInfo($createUpdateCategory) { $returnType = '\Brevo\Client\Model\CreateCategoryModel'; $request = $this->createUpdateCategoryRequest($createUpdateCategory); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createUpdateCategory' * * @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createUpdateCategoryRequest($createUpdateCategory) { // verify the required parameter 'createUpdateCategory' is set if ($createUpdateCategory === null || (is_array($createUpdateCategory) && count($createUpdateCategory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createUpdateCategory when calling createUpdateCategory' ); } $resourcePath = '/categories'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createUpdateCategory)) { $_tempBody = $createUpdateCategory; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createUpdateProduct * * Create/Update a product * * @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateProductModel */ public function createUpdateProduct($createUpdateProduct) { list($response) = $this->createUpdateProductWithHttpInfo($createUpdateProduct); return $response; } /** * Operation createUpdateProductWithHttpInfo * * Create/Update a product * * @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateProductModel, HTTP status code, HTTP response headers (array of strings) */ public function createUpdateProductWithHttpInfo($createUpdateProduct) { $returnType = '\Brevo\Client\Model\CreateProductModel'; $request = $this->createUpdateProductRequest($createUpdateProduct); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateProductModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createUpdateProductAsync * * Create/Update a product * * @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateProductAsync($createUpdateProduct) { return $this->createUpdateProductAsyncWithHttpInfo($createUpdateProduct) ->then( function ($response) { return $response[0]; } ); } /** * Operation createUpdateProductAsyncWithHttpInfo * * Create/Update a product * * @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createUpdateProductAsyncWithHttpInfo($createUpdateProduct) { $returnType = '\Brevo\Client\Model\CreateProductModel'; $request = $this->createUpdateProductRequest($createUpdateProduct); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createUpdateProduct' * * @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createUpdateProductRequest($createUpdateProduct) { // verify the required parameter 'createUpdateProduct' is set if ($createUpdateProduct === null || (is_array($createUpdateProduct) && count($createUpdateProduct) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createUpdateProduct when calling createUpdateProduct' ); } $resourcePath = '/products'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createUpdateProduct)) { $_tempBody = $createUpdateProduct; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation ecommerceActivatePost * * Activate the eCommerce app * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function ecommerceActivatePost() { $this->ecommerceActivatePostWithHttpInfo(); } /** * Operation ecommerceActivatePostWithHttpInfo * * Activate the eCommerce app * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function ecommerceActivatePostWithHttpInfo() { $returnType = ''; $request = $this->ecommerceActivatePostRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 401: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation ecommerceActivatePostAsync * * Activate the eCommerce app * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function ecommerceActivatePostAsync() { return $this->ecommerceActivatePostAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation ecommerceActivatePostAsyncWithHttpInfo * * Activate the eCommerce app * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function ecommerceActivatePostAsyncWithHttpInfo() { $returnType = ''; $request = $this->ecommerceActivatePostRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'ecommerceActivatePost' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function ecommerceActivatePostRequest() { $resourcePath = '/ecommerce/activate'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getCategories * * Return all your categories * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by category ids (optional) * @param string $name Filter by category name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetCategories */ public function getCategories($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null) { list($response) = $this->getCategoriesWithHttpInfo($limit, $offset, $sort, $ids, $name); return $response; } /** * Operation getCategoriesWithHttpInfo * * Return all your categories * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by category ids (optional) * @param string $name Filter by category name (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetCategories, HTTP status code, HTTP response headers (array of strings) */ public function getCategoriesWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null) { $returnType = '\Brevo\Client\Model\GetCategories'; $request = $this->getCategoriesRequest($limit, $offset, $sort, $ids, $name); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetCategories', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getCategoriesAsync * * Return all your categories * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by category ids (optional) * @param string $name Filter by category name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCategoriesAsync($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null) { return $this->getCategoriesAsyncWithHttpInfo($limit, $offset, $sort, $ids, $name) ->then( function ($response) { return $response[0]; } ); } /** * Operation getCategoriesAsyncWithHttpInfo * * Return all your categories * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by category ids (optional) * @param string $name Filter by category name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCategoriesAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null) { $returnType = '\Brevo\Client\Model\GetCategories'; $request = $this->getCategoriesRequest($limit, $offset, $sort, $ids, $name); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getCategories' * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by category ids (optional) * @param string $name Filter by category name (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getCategoriesRequest($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null) { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling EcommerceApi.getCategories, must be smaller than or equal to 100.'); } $resourcePath = '/categories'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if (is_array($ids)) { $queryParams['ids'] = $ids; } else if ($ids !== null) { $queryParams['ids'] = ObjectSerializer::toQueryValue($ids); } // query params if ($name !== null) { $queryParams['name'] = ObjectSerializer::toQueryValue($name); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getCategoryInfo * * Get a category details * * @param string $id Category ID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetCategoryDetails */ public function getCategoryInfo($id) { list($response) = $this->getCategoryInfoWithHttpInfo($id); return $response; } /** * Operation getCategoryInfoWithHttpInfo * * Get a category details * * @param string $id Category ID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetCategoryDetails, HTTP status code, HTTP response headers (array of strings) */ public function getCategoryInfoWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetCategoryDetails'; $request = $this->getCategoryInfoRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetCategoryDetails', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getCategoryInfoAsync * * Get a category details * * @param string $id Category ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCategoryInfoAsync($id) { return $this->getCategoryInfoAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation getCategoryInfoAsyncWithHttpInfo * * Get a category details * * @param string $id Category ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getCategoryInfoAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetCategoryDetails'; $request = $this->getCategoryInfoRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getCategoryInfo' * * @param string $id Category ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getCategoryInfoRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling getCategoryInfo' ); } $resourcePath = '/categories/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getProductInfo * * Get a product's details * * @param string $id Product ID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetProductDetails */ public function getProductInfo($id) { list($response) = $this->getProductInfoWithHttpInfo($id); return $response; } /** * Operation getProductInfoWithHttpInfo * * Get a product's details * * @param string $id Product ID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetProductDetails, HTTP status code, HTTP response headers (array of strings) */ public function getProductInfoWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetProductDetails'; $request = $this->getProductInfoRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetProductDetails', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getProductInfoAsync * * Get a product's details * * @param string $id Product ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProductInfoAsync($id) { return $this->getProductInfoAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation getProductInfoAsyncWithHttpInfo * * Get a product's details * * @param string $id Product ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProductInfoAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\GetProductDetails'; $request = $this->getProductInfoRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getProductInfo' * * @param string $id Product ID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getProductInfoRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling getProductInfo' ); } $resourcePath = '/products/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getProducts * * Return all your products * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by product ids (optional) * @param string $name Filter by product name, minimum 3 characters should be present for search (optional) * @param float $priceLte Price filter for products less than and equals to particular amount (optional) * @param float $priceGte Price filter for products greater than and equals to particular amount (optional) * @param float $priceLt Price filter for products less than particular amount (optional) * @param float $priceGt Price filter for products greater than particular amount (optional) * @param float $priceEq Price filter for products equals to particular amount (optional) * @param float $priceNe Price filter for products not equals to particular amount (optional) * @param string[] $categories Filter by category ids (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetProducts */ public function getProducts($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null) { list($response) = $this->getProductsWithHttpInfo($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories); return $response; } /** * Operation getProductsWithHttpInfo * * Return all your products * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by product ids (optional) * @param string $name Filter by product name, minimum 3 characters should be present for search (optional) * @param float $priceLte Price filter for products less than and equals to particular amount (optional) * @param float $priceGte Price filter for products greater than and equals to particular amount (optional) * @param float $priceLt Price filter for products less than particular amount (optional) * @param float $priceGt Price filter for products greater than particular amount (optional) * @param float $priceEq Price filter for products equals to particular amount (optional) * @param float $priceNe Price filter for products not equals to particular amount (optional) * @param string[] $categories Filter by category ids (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetProducts, HTTP status code, HTTP response headers (array of strings) */ public function getProductsWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null) { $returnType = '\Brevo\Client\Model\GetProducts'; $request = $this->getProductsRequest($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetProducts', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getProductsAsync * * Return all your products * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by product ids (optional) * @param string $name Filter by product name, minimum 3 characters should be present for search (optional) * @param float $priceLte Price filter for products less than and equals to particular amount (optional) * @param float $priceGte Price filter for products greater than and equals to particular amount (optional) * @param float $priceLt Price filter for products less than particular amount (optional) * @param float $priceGt Price filter for products greater than particular amount (optional) * @param float $priceEq Price filter for products equals to particular amount (optional) * @param float $priceNe Price filter for products not equals to particular amount (optional) * @param string[] $categories Filter by category ids (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProductsAsync($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null) { return $this->getProductsAsyncWithHttpInfo($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories) ->then( function ($response) { return $response[0]; } ); } /** * Operation getProductsAsyncWithHttpInfo * * Return all your products * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by product ids (optional) * @param string $name Filter by product name, minimum 3 characters should be present for search (optional) * @param float $priceLte Price filter for products less than and equals to particular amount (optional) * @param float $priceGte Price filter for products greater than and equals to particular amount (optional) * @param float $priceLt Price filter for products less than particular amount (optional) * @param float $priceGt Price filter for products greater than particular amount (optional) * @param float $priceEq Price filter for products equals to particular amount (optional) * @param float $priceNe Price filter for products not equals to particular amount (optional) * @param string[] $categories Filter by category ids (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getProductsAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null) { $returnType = '\Brevo\Client\Model\GetProducts'; $request = $this->getProductsRequest($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getProducts' * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc) * @param string[] $ids Filter by product ids (optional) * @param string $name Filter by product name, minimum 3 characters should be present for search (optional) * @param float $priceLte Price filter for products less than and equals to particular amount (optional) * @param float $priceGte Price filter for products greater than and equals to particular amount (optional) * @param float $priceLt Price filter for products less than particular amount (optional) * @param float $priceGt Price filter for products greater than particular amount (optional) * @param float $priceEq Price filter for products equals to particular amount (optional) * @param float $priceNe Price filter for products not equals to particular amount (optional) * @param string[] $categories Filter by category ids (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getProductsRequest($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null) { if ($limit !== null && $limit > 1000) { throw new \InvalidArgumentException('invalid value for "$limit" when calling EcommerceApi.getProducts, must be smaller than or equal to 1000.'); } $resourcePath = '/products'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if (is_array($ids)) { $queryParams['ids'] = $ids; } else if ($ids !== null) { $queryParams['ids'] = ObjectSerializer::toQueryValue($ids); } // query params if ($name !== null) { $queryParams['name'] = ObjectSerializer::toQueryValue($name); } // query params if ($priceLte !== null) { $queryParams['price[lte]'] = ObjectSerializer::toQueryValue($priceLte); } // query params if ($priceGte !== null) { $queryParams['price[gte]'] = ObjectSerializer::toQueryValue($priceGte); } // query params if ($priceLt !== null) { $queryParams['price[lt]'] = ObjectSerializer::toQueryValue($priceLt); } // query params if ($priceGt !== null) { $queryParams['price[gt]'] = ObjectSerializer::toQueryValue($priceGt); } // query params if ($priceEq !== null) { $queryParams['price[eq]'] = ObjectSerializer::toQueryValue($priceEq); } // query params if ($priceNe !== null) { $queryParams['price[ne]'] = ObjectSerializer::toQueryValue($priceNe); } // query params if (is_array($categories)) { $queryParams['categories'] = $categories; } else if ($categories !== null) { $queryParams['categories'] = ObjectSerializer::toQueryValue($categories); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/WhatsAppCampaignsApi.php 0000644 00000304426 15021222673 0014453 0 ustar 00 <?php /** * WhatsAppCampaignsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * WhatsAppCampaignsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsAppCampaignsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createWhatsAppCampaign * * Create and Send a WhatsApp campaign * * @param \Brevo\Client\Model\CreateWhatsAppCampaign $whatsAppCampaigns Values to create a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createWhatsAppCampaign($whatsAppCampaigns) { list($response) = $this->createWhatsAppCampaignWithHttpInfo($whatsAppCampaigns); return $response; } /** * Operation createWhatsAppCampaignWithHttpInfo * * Create and Send a WhatsApp campaign * * @param \Brevo\Client\Model\CreateWhatsAppCampaign $whatsAppCampaigns Values to create a campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createWhatsAppCampaignWithHttpInfo($whatsAppCampaigns) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWhatsAppCampaignRequest($whatsAppCampaigns); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createWhatsAppCampaignAsync * * Create and Send a WhatsApp campaign * * @param \Brevo\Client\Model\CreateWhatsAppCampaign $whatsAppCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWhatsAppCampaignAsync($whatsAppCampaigns) { return $this->createWhatsAppCampaignAsyncWithHttpInfo($whatsAppCampaigns) ->then( function ($response) { return $response[0]; } ); } /** * Operation createWhatsAppCampaignAsyncWithHttpInfo * * Create and Send a WhatsApp campaign * * @param \Brevo\Client\Model\CreateWhatsAppCampaign $whatsAppCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWhatsAppCampaignAsyncWithHttpInfo($whatsAppCampaigns) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWhatsAppCampaignRequest($whatsAppCampaigns); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createWhatsAppCampaign' * * @param \Brevo\Client\Model\CreateWhatsAppCampaign $whatsAppCampaigns Values to create a campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createWhatsAppCampaignRequest($whatsAppCampaigns) { // verify the required parameter 'whatsAppCampaigns' is set if ($whatsAppCampaigns === null || (is_array($whatsAppCampaigns) && count($whatsAppCampaigns) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $whatsAppCampaigns when calling createWhatsAppCampaign' ); } $resourcePath = '/whatsappCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($whatsAppCampaigns)) { $_tempBody = $whatsAppCampaigns; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation createWhatsAppTemplate * * Create a WhatsApp template * * @param \Brevo\Client\Model\CreateWhatsAppTemplate $whatsAppTemplates Values to create a template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createWhatsAppTemplate($whatsAppTemplates) { list($response) = $this->createWhatsAppTemplateWithHttpInfo($whatsAppTemplates); return $response; } /** * Operation createWhatsAppTemplateWithHttpInfo * * Create a WhatsApp template * * @param \Brevo\Client\Model\CreateWhatsAppTemplate $whatsAppTemplates Values to create a template (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createWhatsAppTemplateWithHttpInfo($whatsAppTemplates) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWhatsAppTemplateRequest($whatsAppTemplates); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createWhatsAppTemplateAsync * * Create a WhatsApp template * * @param \Brevo\Client\Model\CreateWhatsAppTemplate $whatsAppTemplates Values to create a template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWhatsAppTemplateAsync($whatsAppTemplates) { return $this->createWhatsAppTemplateAsyncWithHttpInfo($whatsAppTemplates) ->then( function ($response) { return $response[0]; } ); } /** * Operation createWhatsAppTemplateAsyncWithHttpInfo * * Create a WhatsApp template * * @param \Brevo\Client\Model\CreateWhatsAppTemplate $whatsAppTemplates Values to create a template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWhatsAppTemplateAsyncWithHttpInfo($whatsAppTemplates) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWhatsAppTemplateRequest($whatsAppTemplates); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createWhatsAppTemplate' * * @param \Brevo\Client\Model\CreateWhatsAppTemplate $whatsAppTemplates Values to create a template (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createWhatsAppTemplateRequest($whatsAppTemplates) { // verify the required parameter 'whatsAppTemplates' is set if ($whatsAppTemplates === null || (is_array($whatsAppTemplates) && count($whatsAppTemplates) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $whatsAppTemplates when calling createWhatsAppTemplate' ); } $resourcePath = '/whatsappCampaigns/template'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($whatsAppTemplates)) { $_tempBody = $whatsAppTemplates; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteWhatsAppCampaign * * Delete a WhatsApp campaign * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteWhatsAppCampaign($campaignId) { $this->deleteWhatsAppCampaignWithHttpInfo($campaignId); } /** * Operation deleteWhatsAppCampaignWithHttpInfo * * Delete a WhatsApp campaign * * @param int $campaignId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteWhatsAppCampaignWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteWhatsAppCampaignRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteWhatsAppCampaignAsync * * Delete a WhatsApp campaign * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteWhatsAppCampaignAsync($campaignId) { return $this->deleteWhatsAppCampaignAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteWhatsAppCampaignAsyncWithHttpInfo * * Delete a WhatsApp campaign * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteWhatsAppCampaignAsyncWithHttpInfo($campaignId) { $returnType = ''; $request = $this->deleteWhatsAppCampaignRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteWhatsAppCampaign' * * @param int $campaignId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteWhatsAppCampaignRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling deleteWhatsAppCampaign' ); } $resourcePath = '/whatsappCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWhatsAppCampaign * * Get a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWhatsappCampaignOverview */ public function getWhatsAppCampaign($campaignId) { list($response) = $this->getWhatsAppCampaignWithHttpInfo($campaignId); return $response; } /** * Operation getWhatsAppCampaignWithHttpInfo * * Get a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWhatsappCampaignOverview, HTTP status code, HTTP response headers (array of strings) */ public function getWhatsAppCampaignWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetWhatsappCampaignOverview'; $request = $this->getWhatsAppCampaignRequest($campaignId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWhatsappCampaignOverview', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWhatsAppCampaignAsync * * Get a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppCampaignAsync($campaignId) { return $this->getWhatsAppCampaignAsyncWithHttpInfo($campaignId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWhatsAppCampaignAsyncWithHttpInfo * * Get a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppCampaignAsyncWithHttpInfo($campaignId) { $returnType = '\Brevo\Client\Model\GetWhatsappCampaignOverview'; $request = $this->getWhatsAppCampaignRequest($campaignId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWhatsAppCampaign' * * @param int $campaignId Id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWhatsAppCampaignRequest($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling getWhatsAppCampaign' ); } $resourcePath = '/whatsappCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWhatsAppCampaigns * * Return all your created WhatsApp campaigns * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWhatsappCampaigns */ public function getWhatsAppCampaigns($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getWhatsAppCampaignsWithHttpInfo($startDate, $endDate, $limit, $offset, $sort); return $response; } /** * Operation getWhatsAppCampaignsWithHttpInfo * * Return all your created WhatsApp campaigns * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWhatsappCampaigns, HTTP status code, HTTP response headers (array of strings) */ public function getWhatsAppCampaignsWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWhatsappCampaigns'; $request = $this->getWhatsAppCampaignsRequest($startDate, $endDate, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWhatsappCampaigns', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWhatsAppCampaignsAsync * * Return all your created WhatsApp campaigns * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppCampaignsAsync($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { return $this->getWhatsAppCampaignsAsyncWithHttpInfo($startDate, $endDate, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWhatsAppCampaignsAsyncWithHttpInfo * * Return all your created WhatsApp campaigns * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppCampaignsAsyncWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWhatsappCampaigns'; $request = $this->getWhatsAppCampaignsRequest($startDate, $endDate, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWhatsAppCampaigns' * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWhatsAppCampaignsRequest($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling WhatsAppCampaignsApi.getWhatsAppCampaigns, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling WhatsAppCampaignsApi.getWhatsAppCampaigns, must be bigger than or equal to 0.'); } $resourcePath = '/whatsappCampaigns'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWhatsAppConfig * * Get your WhatsApp API account information * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWhatsAppConfig */ public function getWhatsAppConfig() { list($response) = $this->getWhatsAppConfigWithHttpInfo(); return $response; } /** * Operation getWhatsAppConfigWithHttpInfo * * Get your WhatsApp API account information * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWhatsAppConfig, HTTP status code, HTTP response headers (array of strings) */ public function getWhatsAppConfigWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetWhatsAppConfig'; $request = $this->getWhatsAppConfigRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWhatsAppConfig', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWhatsAppConfigAsync * * Get your WhatsApp API account information * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppConfigAsync() { return $this->getWhatsAppConfigAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation getWhatsAppConfigAsyncWithHttpInfo * * Get your WhatsApp API account information * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppConfigAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\GetWhatsAppConfig'; $request = $this->getWhatsAppConfigRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWhatsAppConfig' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWhatsAppConfigRequest() { $resourcePath = '/whatsappCampaigns/config'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWhatsAppTemplates * * Return all your created WhatsApp templates * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWATemplates */ public function getWhatsAppTemplates($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { list($response) = $this->getWhatsAppTemplatesWithHttpInfo($startDate, $endDate, $limit, $offset, $sort); return $response; } /** * Operation getWhatsAppTemplatesWithHttpInfo * * Return all your created WhatsApp templates * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWATemplates, HTTP status code, HTTP response headers (array of strings) */ public function getWhatsAppTemplatesWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWATemplates'; $request = $this->getWhatsAppTemplatesRequest($startDate, $endDate, $limit, $offset, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWATemplates', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWhatsAppTemplatesAsync * * Return all your created WhatsApp templates * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppTemplatesAsync($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { return $this->getWhatsAppTemplatesAsyncWithHttpInfo($startDate, $endDate, $limit, $offset, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWhatsAppTemplatesAsyncWithHttpInfo * * Return all your created WhatsApp templates * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWhatsAppTemplatesAsyncWithHttpInfo($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWATemplates'; $request = $this->getWhatsAppTemplatesRequest($startDate, $endDate, $limit, $offset, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWhatsAppTemplates' * * @param string $startDate **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param string $endDate **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result** (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document in the page (optional, default to 0) * @param string $sort Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWhatsAppTemplatesRequest($startDate = null, $endDate = null, $limit = '50', $offset = '0', $sort = 'desc') { if ($limit !== null && $limit > 100) { throw new \InvalidArgumentException('invalid value for "$limit" when calling WhatsAppCampaignsApi.getWhatsAppTemplates, must be smaller than or equal to 100.'); } if ($limit !== null && $limit < 0) { throw new \InvalidArgumentException('invalid value for "$limit" when calling WhatsAppCampaignsApi.getWhatsAppTemplates, must be bigger than or equal to 0.'); } $resourcePath = '/whatsappCampaigns/template-list'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($startDate !== null) { $queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate); } // query params if ($endDate !== null) { $queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation sendWhatsAppTemplateApproval * * Send your WhatsApp template for approval * * @param int $templateId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function sendWhatsAppTemplateApproval($templateId) { $this->sendWhatsAppTemplateApprovalWithHttpInfo($templateId); } /** * Operation sendWhatsAppTemplateApprovalWithHttpInfo * * Send your WhatsApp template for approval * * @param int $templateId id of the campaign (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function sendWhatsAppTemplateApprovalWithHttpInfo($templateId) { $returnType = ''; $request = $this->sendWhatsAppTemplateApprovalRequest($templateId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation sendWhatsAppTemplateApprovalAsync * * Send your WhatsApp template for approval * * @param int $templateId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendWhatsAppTemplateApprovalAsync($templateId) { return $this->sendWhatsAppTemplateApprovalAsyncWithHttpInfo($templateId) ->then( function ($response) { return $response[0]; } ); } /** * Operation sendWhatsAppTemplateApprovalAsyncWithHttpInfo * * Send your WhatsApp template for approval * * @param int $templateId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function sendWhatsAppTemplateApprovalAsyncWithHttpInfo($templateId) { $returnType = ''; $request = $this->sendWhatsAppTemplateApprovalRequest($templateId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'sendWhatsAppTemplateApproval' * * @param int $templateId id of the campaign (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function sendWhatsAppTemplateApprovalRequest($templateId) { // verify the required parameter 'templateId' is set if ($templateId === null || (is_array($templateId) && count($templateId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $templateId when calling sendWhatsAppTemplateApproval' ); } $resourcePath = '/whatsappCampaigns/template/approval/{templateId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($templateId !== null) { $resourcePath = str_replace( '{' . 'templateId' . '}', ObjectSerializer::toPathValue($templateId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateWhatsAppCampaign * * Update a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateWhatsAppCampaign $whatsAppCampaign values to update WhatsApp Campaign (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateWhatsAppCampaign($campaignId, $whatsAppCampaign = null) { $this->updateWhatsAppCampaignWithHttpInfo($campaignId, $whatsAppCampaign); } /** * Operation updateWhatsAppCampaignWithHttpInfo * * Update a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateWhatsAppCampaign $whatsAppCampaign values to update WhatsApp Campaign (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateWhatsAppCampaignWithHttpInfo($campaignId, $whatsAppCampaign = null) { $returnType = ''; $request = $this->updateWhatsAppCampaignRequest($campaignId, $whatsAppCampaign); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateWhatsAppCampaignAsync * * Update a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateWhatsAppCampaign $whatsAppCampaign values to update WhatsApp Campaign (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateWhatsAppCampaignAsync($campaignId, $whatsAppCampaign = null) { return $this->updateWhatsAppCampaignAsyncWithHttpInfo($campaignId, $whatsAppCampaign) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateWhatsAppCampaignAsyncWithHttpInfo * * Update a WhatsApp campaign * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateWhatsAppCampaign $whatsAppCampaign values to update WhatsApp Campaign (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateWhatsAppCampaignAsyncWithHttpInfo($campaignId, $whatsAppCampaign = null) { $returnType = ''; $request = $this->updateWhatsAppCampaignRequest($campaignId, $whatsAppCampaign); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateWhatsAppCampaign' * * @param int $campaignId Id of the campaign (required) * @param \Brevo\Client\Model\UpdateWhatsAppCampaign $whatsAppCampaign values to update WhatsApp Campaign (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateWhatsAppCampaignRequest($campaignId, $whatsAppCampaign = null) { // verify the required parameter 'campaignId' is set if ($campaignId === null || (is_array($campaignId) && count($campaignId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $campaignId when calling updateWhatsAppCampaign' ); } $resourcePath = '/whatsappCampaigns/{campaignId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($campaignId !== null) { $resourcePath = str_replace( '{' . 'campaignId' . '}', ObjectSerializer::toPathValue($campaignId), $resourcePath ); } // body params $_tempBody = null; if (isset($whatsAppCampaign)) { $_tempBody = $whatsAppCampaign; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/WebhooksApi.php 0000644 00000171532 15021222673 0012662 0 ustar 00 <?php /** * WebhooksApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * WebhooksApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WebhooksApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation createWebhook * * Create a webhook * * @param \Brevo\Client\Model\CreateWebhook $createWebhook Values to create a webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreateModel */ public function createWebhook($createWebhook) { list($response) = $this->createWebhookWithHttpInfo($createWebhook); return $response; } /** * Operation createWebhookWithHttpInfo * * Create a webhook * * @param \Brevo\Client\Model\CreateWebhook $createWebhook Values to create a webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ public function createWebhookWithHttpInfo($createWebhook) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWebhookRequest($createWebhook); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreateModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation createWebhookAsync * * Create a webhook * * @param \Brevo\Client\Model\CreateWebhook $createWebhook Values to create a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWebhookAsync($createWebhook) { return $this->createWebhookAsyncWithHttpInfo($createWebhook) ->then( function ($response) { return $response[0]; } ); } /** * Operation createWebhookAsyncWithHttpInfo * * Create a webhook * * @param \Brevo\Client\Model\CreateWebhook $createWebhook Values to create a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function createWebhookAsyncWithHttpInfo($createWebhook) { $returnType = '\Brevo\Client\Model\CreateModel'; $request = $this->createWebhookRequest($createWebhook); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'createWebhook' * * @param \Brevo\Client\Model\CreateWebhook $createWebhook Values to create a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function createWebhookRequest($createWebhook) { // verify the required parameter 'createWebhook' is set if ($createWebhook === null || (is_array($createWebhook) && count($createWebhook) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $createWebhook when calling createWebhook' ); } $resourcePath = '/webhooks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($createWebhook)) { $_tempBody = $createWebhook; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation deleteWebhook * * Delete a webhook * * @param int $webhookId Id of the webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function deleteWebhook($webhookId) { $this->deleteWebhookWithHttpInfo($webhookId); } /** * Operation deleteWebhookWithHttpInfo * * Delete a webhook * * @param int $webhookId Id of the webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function deleteWebhookWithHttpInfo($webhookId) { $returnType = ''; $request = $this->deleteWebhookRequest($webhookId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation deleteWebhookAsync * * Delete a webhook * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteWebhookAsync($webhookId) { return $this->deleteWebhookAsyncWithHttpInfo($webhookId) ->then( function ($response) { return $response[0]; } ); } /** * Operation deleteWebhookAsyncWithHttpInfo * * Delete a webhook * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function deleteWebhookAsyncWithHttpInfo($webhookId) { $returnType = ''; $request = $this->deleteWebhookRequest($webhookId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'deleteWebhook' * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function deleteWebhookRequest($webhookId) { // verify the required parameter 'webhookId' is set if ($webhookId === null || (is_array($webhookId) && count($webhookId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $webhookId when calling deleteWebhook' ); } $resourcePath = '/webhooks/{webhookId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($webhookId !== null) { $resourcePath = str_replace( '{' . 'webhookId' . '}', ObjectSerializer::toPathValue($webhookId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation exportWebhooksHistory * * Export all transactional events * * @param \Brevo\Client\Model\ExportWebhooksHistory $exportWebhookHistory Values to submit for webhooks history (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\CreatedProcessId */ public function exportWebhooksHistory($exportWebhookHistory) { list($response) = $this->exportWebhooksHistoryWithHttpInfo($exportWebhookHistory); return $response; } /** * Operation exportWebhooksHistoryWithHttpInfo * * Export all transactional events * * @param \Brevo\Client\Model\ExportWebhooksHistory $exportWebhookHistory Values to submit for webhooks history (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ public function exportWebhooksHistoryWithHttpInfo($exportWebhookHistory) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->exportWebhooksHistoryRequest($exportWebhookHistory); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 202: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\CreatedProcessId', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation exportWebhooksHistoryAsync * * Export all transactional events * * @param \Brevo\Client\Model\ExportWebhooksHistory $exportWebhookHistory Values to submit for webhooks history (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function exportWebhooksHistoryAsync($exportWebhookHistory) { return $this->exportWebhooksHistoryAsyncWithHttpInfo($exportWebhookHistory) ->then( function ($response) { return $response[0]; } ); } /** * Operation exportWebhooksHistoryAsyncWithHttpInfo * * Export all transactional events * * @param \Brevo\Client\Model\ExportWebhooksHistory $exportWebhookHistory Values to submit for webhooks history (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function exportWebhooksHistoryAsyncWithHttpInfo($exportWebhookHistory) { $returnType = '\Brevo\Client\Model\CreatedProcessId'; $request = $this->exportWebhooksHistoryRequest($exportWebhookHistory); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'exportWebhooksHistory' * * @param \Brevo\Client\Model\ExportWebhooksHistory $exportWebhookHistory Values to submit for webhooks history (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function exportWebhooksHistoryRequest($exportWebhookHistory) { // verify the required parameter 'exportWebhookHistory' is set if ($exportWebhookHistory === null || (is_array($exportWebhookHistory) && count($exportWebhookHistory) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $exportWebhookHistory when calling exportWebhooksHistory' ); } $resourcePath = '/webhooks/export'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($exportWebhookHistory)) { $_tempBody = $exportWebhookHistory; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWebhook * * Get a webhook details * * @param int $webhookId Id of the webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWebhook */ public function getWebhook($webhookId) { list($response) = $this->getWebhookWithHttpInfo($webhookId); return $response; } /** * Operation getWebhookWithHttpInfo * * Get a webhook details * * @param int $webhookId Id of the webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWebhook, HTTP status code, HTTP response headers (array of strings) */ public function getWebhookWithHttpInfo($webhookId) { $returnType = '\Brevo\Client\Model\GetWebhook'; $request = $this->getWebhookRequest($webhookId); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWebhook', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWebhookAsync * * Get a webhook details * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWebhookAsync($webhookId) { return $this->getWebhookAsyncWithHttpInfo($webhookId) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWebhookAsyncWithHttpInfo * * Get a webhook details * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWebhookAsyncWithHttpInfo($webhookId) { $returnType = '\Brevo\Client\Model\GetWebhook'; $request = $this->getWebhookRequest($webhookId); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWebhook' * * @param int $webhookId Id of the webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWebhookRequest($webhookId) { // verify the required parameter 'webhookId' is set if ($webhookId === null || (is_array($webhookId) && count($webhookId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $webhookId when calling getWebhook' ); } $resourcePath = '/webhooks/{webhookId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($webhookId !== null) { $resourcePath = str_replace( '{' . 'webhookId' . '}', ObjectSerializer::toPathValue($webhookId), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation getWebhooks * * Get all webhooks * * @param string $type Filter on webhook type (optional, default to transactional) * @param string $sort Sort the results in the ascending/descending order of webhook creation (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\GetWebhooks */ public function getWebhooks($type = 'transactional', $sort = 'desc') { list($response) = $this->getWebhooksWithHttpInfo($type, $sort); return $response; } /** * Operation getWebhooksWithHttpInfo * * Get all webhooks * * @param string $type Filter on webhook type (optional, default to transactional) * @param string $sort Sort the results in the ascending/descending order of webhook creation (optional, default to desc) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\GetWebhooks, HTTP status code, HTTP response headers (array of strings) */ public function getWebhooksWithHttpInfo($type = 'transactional', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWebhooks'; $request = $this->getWebhooksRequest($type, $sort); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\GetWebhooks', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation getWebhooksAsync * * Get all webhooks * * @param string $type Filter on webhook type (optional, default to transactional) * @param string $sort Sort the results in the ascending/descending order of webhook creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWebhooksAsync($type = 'transactional', $sort = 'desc') { return $this->getWebhooksAsyncWithHttpInfo($type, $sort) ->then( function ($response) { return $response[0]; } ); } /** * Operation getWebhooksAsyncWithHttpInfo * * Get all webhooks * * @param string $type Filter on webhook type (optional, default to transactional) * @param string $sort Sort the results in the ascending/descending order of webhook creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function getWebhooksAsyncWithHttpInfo($type = 'transactional', $sort = 'desc') { $returnType = '\Brevo\Client\Model\GetWebhooks'; $request = $this->getWebhooksRequest($type, $sort); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'getWebhooks' * * @param string $type Filter on webhook type (optional, default to transactional) * @param string $sort Sort the results in the ascending/descending order of webhook creation (optional, default to desc) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function getWebhooksRequest($type = 'transactional', $sort = 'desc') { $resourcePath = '/webhooks'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($type !== null) { $queryParams['type'] = ObjectSerializer::toQueryValue($type); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation updateWebhook * * Update a webhook * * @param int $webhookId Id of the webhook (required) * @param \Brevo\Client\Model\UpdateWebhook $updateWebhook Values to update a webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function updateWebhook($webhookId, $updateWebhook) { $this->updateWebhookWithHttpInfo($webhookId, $updateWebhook); } /** * Operation updateWebhookWithHttpInfo * * Update a webhook * * @param int $webhookId Id of the webhook (required) * @param \Brevo\Client\Model\UpdateWebhook $updateWebhook Values to update a webhook (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function updateWebhookWithHttpInfo($webhookId, $updateWebhook) { $returnType = ''; $request = $this->updateWebhookRequest($webhookId, $updateWebhook); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation updateWebhookAsync * * Update a webhook * * @param int $webhookId Id of the webhook (required) * @param \Brevo\Client\Model\UpdateWebhook $updateWebhook Values to update a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateWebhookAsync($webhookId, $updateWebhook) { return $this->updateWebhookAsyncWithHttpInfo($webhookId, $updateWebhook) ->then( function ($response) { return $response[0]; } ); } /** * Operation updateWebhookAsyncWithHttpInfo * * Update a webhook * * @param int $webhookId Id of the webhook (required) * @param \Brevo\Client\Model\UpdateWebhook $updateWebhook Values to update a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function updateWebhookAsyncWithHttpInfo($webhookId, $updateWebhook) { $returnType = ''; $request = $this->updateWebhookRequest($webhookId, $updateWebhook); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'updateWebhook' * * @param int $webhookId Id of the webhook (required) * @param \Brevo\Client\Model\UpdateWebhook $updateWebhook Values to update a webhook (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function updateWebhookRequest($webhookId, $updateWebhook) { // verify the required parameter 'webhookId' is set if ($webhookId === null || (is_array($webhookId) && count($webhookId) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $webhookId when calling updateWebhook' ); } // verify the required parameter 'updateWebhook' is set if ($updateWebhook === null || (is_array($updateWebhook) && count($updateWebhook) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $updateWebhook when calling updateWebhook' ); } $resourcePath = '/webhooks/{webhookId}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($webhookId !== null) { $resourcePath = str_replace( '{' . 'webhookId' . '}', ObjectSerializer::toPathValue($webhookId), $resourcePath ); } // body params $_tempBody = null; if (isset($updateWebhook)) { $_tempBody = $updateWebhook; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PUT', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/Api/DealsApi.php 0000644 00000304571 15021222673 0012132 0 ustar 00 <?php /** * DealsApi * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Api; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; use Brevo\Client\ApiException; use Brevo\Client\Configuration; use Brevo\Client\HeaderSelector; use Brevo\Client\ObjectSerializer; /** * DealsApi Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealsApi { /** * @var ClientInterface */ protected $client; /** * @var Configuration */ protected $config; /** * @var HeaderSelector */ protected $headerSelector; /** * @param ClientInterface $client * @param Configuration $config * @param HeaderSelector $selector */ public function __construct( ClientInterface $client = null, Configuration $config = null, HeaderSelector $selector = null ) { $this->client = $client ?: new Client(); $this->config = $config ?: new Configuration(); $this->headerSelector = $selector ?: new HeaderSelector(); } /** * @return Configuration */ public function getConfig() { return $this->config; } /** * Operation crmAttributesDealsGet * * Get deal attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\DealAttributes */ public function crmAttributesDealsGet() { list($response) = $this->crmAttributesDealsGetWithHttpInfo(); return $response; } /** * Operation crmAttributesDealsGetWithHttpInfo * * Get deal attributes * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\DealAttributes, HTTP status code, HTTP response headers (array of strings) */ public function crmAttributesDealsGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\DealAttributes'; $request = $this->crmAttributesDealsGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\DealAttributes', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmAttributesDealsGetAsync * * Get deal attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmAttributesDealsGetAsync() { return $this->crmAttributesDealsGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation crmAttributesDealsGetAsyncWithHttpInfo * * Get deal attributes * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmAttributesDealsGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\DealAttributes'; $request = $this->crmAttributesDealsGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmAttributesDealsGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmAttributesDealsGetRequest() { $resourcePath = '/crm/attributes/deals'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsGet * * Get all deals * * @param string $filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" (optional) * @param string $filtersLinkedCompaniesIds Filter by linked companies ids (optional) * @param string $filtersLinkedContactsIds Filter by linked companies ids (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\DealsList */ public function crmDealsGet($filtersAttributesDealName = null, $filtersLinkedCompaniesIds = null, $filtersLinkedContactsIds = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { list($response) = $this->crmDealsGetWithHttpInfo($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy); return $response; } /** * Operation crmDealsGetWithHttpInfo * * Get all deals * * @param string $filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" (optional) * @param string $filtersLinkedCompaniesIds Filter by linked companies ids (optional) * @param string $filtersLinkedContactsIds Filter by linked companies ids (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\DealsList, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsGetWithHttpInfo($filtersAttributesDealName = null, $filtersLinkedCompaniesIds = null, $filtersLinkedContactsIds = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\DealsList'; $request = $this->crmDealsGetRequest($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\DealsList', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsGetAsync * * Get all deals * * @param string $filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" (optional) * @param string $filtersLinkedCompaniesIds Filter by linked companies ids (optional) * @param string $filtersLinkedContactsIds Filter by linked companies ids (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsGetAsync($filtersAttributesDealName = null, $filtersLinkedCompaniesIds = null, $filtersLinkedContactsIds = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { return $this->crmDealsGetAsyncWithHttpInfo($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsGetAsyncWithHttpInfo * * Get all deals * * @param string $filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" (optional) * @param string $filtersLinkedCompaniesIds Filter by linked companies ids (optional) * @param string $filtersLinkedContactsIds Filter by linked companies ids (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsGetAsyncWithHttpInfo($filtersAttributesDealName = null, $filtersLinkedCompaniesIds = null, $filtersLinkedContactsIds = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $returnType = '\Brevo\Client\Model\DealsList'; $request = $this->crmDealsGetRequest($filtersAttributesDealName, $filtersLinkedCompaniesIds, $filtersLinkedContactsIds, $offset, $limit, $sort, $sortBy); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsGet' * * @param string $filtersAttributesDealName Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" (optional) * @param string $filtersLinkedCompaniesIds Filter by linked companies ids (optional) * @param string $filtersLinkedContactsIds Filter by linked companies ids (optional) * @param int $offset Index of the first document of the page (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional) * @param string $sortBy The field used to sort field names. (optional) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsGetRequest($filtersAttributesDealName = null, $filtersLinkedCompaniesIds = null, $filtersLinkedContactsIds = null, $offset = null, $limit = '50', $sort = null, $sortBy = null) { $resourcePath = '/crm/deals'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // query params if ($filtersAttributesDealName !== null) { $queryParams['filters[attributes.deal_name]'] = ObjectSerializer::toQueryValue($filtersAttributesDealName); } // query params if ($filtersLinkedCompaniesIds !== null) { $queryParams['filters[linkedCompaniesIds]'] = ObjectSerializer::toQueryValue($filtersLinkedCompaniesIds); } // query params if ($filtersLinkedContactsIds !== null) { $queryParams['filters[linkedContactsIds]'] = ObjectSerializer::toQueryValue($filtersLinkedContactsIds); } // query params if ($offset !== null) { $queryParams['offset'] = ObjectSerializer::toQueryValue($offset); } // query params if ($limit !== null) { $queryParams['limit'] = ObjectSerializer::toQueryValue($limit); } // query params if ($sort !== null) { $queryParams['sort'] = ObjectSerializer::toQueryValue($sort); } // query params if ($sortBy !== null) { $queryParams['sortBy'] = ObjectSerializer::toQueryValue($sortBy); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsIdDelete * * Delete a deal * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmDealsIdDelete($id) { $this->crmDealsIdDeleteWithHttpInfo($id); } /** * Operation crmDealsIdDeleteWithHttpInfo * * Delete a deal * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsIdDeleteWithHttpInfo($id) { $returnType = ''; $request = $this->crmDealsIdDeleteRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsIdDeleteAsync * * Delete a deal * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdDeleteAsync($id) { return $this->crmDealsIdDeleteAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsIdDeleteAsyncWithHttpInfo * * Delete a deal * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdDeleteAsyncWithHttpInfo($id) { $returnType = ''; $request = $this->crmDealsIdDeleteRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsIdDelete' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsIdDeleteRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmDealsIdDelete' ); } $resourcePath = '/crm/deals/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'DELETE', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsIdGet * * Get a deal * * @param string $id id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Deal */ public function crmDealsIdGet($id) { list($response) = $this->crmDealsIdGetWithHttpInfo($id); return $response; } /** * Operation crmDealsIdGetWithHttpInfo * * Get a deal * * @param string $id (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Deal, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsIdGetWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Deal'; $request = $this->crmDealsIdGetRequest($id); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Deal', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsIdGetAsync * * Get a deal * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdGetAsync($id) { return $this->crmDealsIdGetAsyncWithHttpInfo($id) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsIdGetAsyncWithHttpInfo * * Get a deal * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdGetAsyncWithHttpInfo($id) { $returnType = '\Brevo\Client\Model\Deal'; $request = $this->crmDealsIdGetRequest($id); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsIdGet' * * @param string $id (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsIdGetRequest($id) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmDealsIdGet' ); } $resourcePath = '/crm/deals/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsIdPatch * * Update a deal * * @param string $id id (required) * @param \Brevo\Client\Model\Body4 $body Updated deal details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmDealsIdPatch($id, $body) { $this->crmDealsIdPatchWithHttpInfo($id, $body); } /** * Operation crmDealsIdPatchWithHttpInfo * * Update a deal * * @param string $id (required) * @param \Brevo\Client\Model\Body4 $body Updated deal details. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmDealsIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 404: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsIdPatchAsync * * Update a deal * * @param string $id (required) * @param \Brevo\Client\Model\Body4 $body Updated deal details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdPatchAsync($id, $body) { return $this->crmDealsIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsIdPatchAsyncWithHttpInfo * * Update a deal * * @param string $id (required) * @param \Brevo\Client\Model\Body4 $body Updated deal details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmDealsIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body4 $body Updated deal details. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmDealsIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmDealsIdPatch' ); } $resourcePath = '/crm/deals/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsLinkUnlinkIdPatch * * Link and Unlink a deal with contacts and companies * * @param string $id id (required) * @param \Brevo\Client\Model\Body5 $body Linked / Unlinked contacts and companies ids. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return void */ public function crmDealsLinkUnlinkIdPatch($id, $body) { $this->crmDealsLinkUnlinkIdPatchWithHttpInfo($id, $body); } /** * Operation crmDealsLinkUnlinkIdPatchWithHttpInfo * * Link and Unlink a deal with contacts and companies * * @param string $id (required) * @param \Brevo\Client\Model\Body5 $body Linked / Unlinked contacts and companies ids. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of null, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsLinkUnlinkIdPatchWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmDealsLinkUnlinkIdPatchRequest($id, $body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } return [null, $statusCode, $response->getHeaders()]; } catch (ApiException $e) { switch ($e->getCode()) { case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsLinkUnlinkIdPatchAsync * * Link and Unlink a deal with contacts and companies * * @param string $id (required) * @param \Brevo\Client\Model\Body5 $body Linked / Unlinked contacts and companies ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsLinkUnlinkIdPatchAsync($id, $body) { return $this->crmDealsLinkUnlinkIdPatchAsyncWithHttpInfo($id, $body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsLinkUnlinkIdPatchAsyncWithHttpInfo * * Link and Unlink a deal with contacts and companies * * @param string $id (required) * @param \Brevo\Client\Model\Body5 $body Linked / Unlinked contacts and companies ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsLinkUnlinkIdPatchAsyncWithHttpInfo($id, $body) { $returnType = ''; $request = $this->crmDealsLinkUnlinkIdPatchRequest($id, $body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { return [null, $response->getStatusCode(), $response->getHeaders()]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsLinkUnlinkIdPatch' * * @param string $id (required) * @param \Brevo\Client\Model\Body5 $body Linked / Unlinked contacts and companies ids. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsLinkUnlinkIdPatchRequest($id, $body) { // verify the required parameter 'id' is set if ($id === null || (is_array($id) && count($id) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $id when calling crmDealsLinkUnlinkIdPatch' ); } // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmDealsLinkUnlinkIdPatch' ); } $resourcePath = '/crm/deals/link-unlink/{id}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($id !== null) { $resourcePath = str_replace( '{' . 'id' . '}', ObjectSerializer::toPathValue($id), $resourcePath ); } // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'PATCH', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmDealsPost * * Create a deal * * @param \Brevo\Client\Model\Body3 $body Deal create data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\InlineResponse201 */ public function crmDealsPost($body) { list($response) = $this->crmDealsPostWithHttpInfo($body); return $response; } /** * Operation crmDealsPostWithHttpInfo * * Create a deal * * @param \Brevo\Client\Model\Body3 $body Deal create data. (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\InlineResponse201, HTTP status code, HTTP response headers (array of strings) */ public function crmDealsPostWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse201'; $request = $this->crmDealsPostRequest($body); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 201: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\InlineResponse201', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmDealsPostAsync * * Create a deal * * @param \Brevo\Client\Model\Body3 $body Deal create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsPostAsync($body) { return $this->crmDealsPostAsyncWithHttpInfo($body) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmDealsPostAsyncWithHttpInfo * * Create a deal * * @param \Brevo\Client\Model\Body3 $body Deal create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmDealsPostAsyncWithHttpInfo($body) { $returnType = '\Brevo\Client\Model\InlineResponse201'; $request = $this->crmDealsPostRequest($body); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmDealsPost' * * @param \Brevo\Client\Model\Body3 $body Deal create data. (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmDealsPostRequest($body) { // verify the required parameter 'body' is set if ($body === null || (is_array($body) && count($body) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $body when calling crmDealsPost' ); } $resourcePath = '/crm/deals'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if (isset($body)) { $_tempBody = $body; } if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'POST', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmPipelineDetailsAllGet * * Get all pipelines * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Pipelines */ public function crmPipelineDetailsAllGet() { list($response) = $this->crmPipelineDetailsAllGetWithHttpInfo(); return $response; } /** * Operation crmPipelineDetailsAllGetWithHttpInfo * * Get all pipelines * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Pipelines, HTTP status code, HTTP response headers (array of strings) */ public function crmPipelineDetailsAllGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\Pipelines'; $request = $this->crmPipelineDetailsAllGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Pipelines', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmPipelineDetailsAllGetAsync * * Get all pipelines * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsAllGetAsync() { return $this->crmPipelineDetailsAllGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation crmPipelineDetailsAllGetAsyncWithHttpInfo * * Get all pipelines * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsAllGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\Pipelines'; $request = $this->crmPipelineDetailsAllGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmPipelineDetailsAllGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmPipelineDetailsAllGetRequest() { $resourcePath = '/crm/pipeline/details/all'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmPipelineDetailsGet * * Get pipeline stages * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Pipeline */ public function crmPipelineDetailsGet() { list($response) = $this->crmPipelineDetailsGetWithHttpInfo(); return $response; } /** * Operation crmPipelineDetailsGetWithHttpInfo * * Get pipeline stages * * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Pipeline, HTTP status code, HTTP response headers (array of strings) */ public function crmPipelineDetailsGetWithHttpInfo() { $returnType = '\Brevo\Client\Model\Pipeline'; $request = $this->crmPipelineDetailsGetRequest(); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Pipeline', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmPipelineDetailsGetAsync * * Get pipeline stages * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsGetAsync() { return $this->crmPipelineDetailsGetAsyncWithHttpInfo() ->then( function ($response) { return $response[0]; } ); } /** * Operation crmPipelineDetailsGetAsyncWithHttpInfo * * Get pipeline stages * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsGetAsyncWithHttpInfo() { $returnType = '\Brevo\Client\Model\Pipeline'; $request = $this->crmPipelineDetailsGetRequest(); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmPipelineDetailsGet' * * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmPipelineDetailsGetRequest() { $resourcePath = '/crm/pipeline/details'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Operation crmPipelineDetailsPipelineIDGet * * Get a pipeline * * @param string $pipelineID pipelineID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return \Brevo\Client\Model\Pipelines */ public function crmPipelineDetailsPipelineIDGet($pipelineID) { list($response) = $this->crmPipelineDetailsPipelineIDGetWithHttpInfo($pipelineID); return $response; } /** * Operation crmPipelineDetailsPipelineIDGetWithHttpInfo * * Get a pipeline * * @param string $pipelineID (required) * * @throws \Brevo\Client\ApiException on non-2xx response * @throws \InvalidArgumentException * @return array of \Brevo\Client\Model\Pipelines, HTTP status code, HTTP response headers (array of strings) */ public function crmPipelineDetailsPipelineIDGetWithHttpInfo($pipelineID) { $returnType = '\Brevo\Client\Model\Pipelines'; $request = $this->crmPipelineDetailsPipelineIDGetRequest($pipelineID); try { $options = $this->createHttpClientOption(); try { $response = $this->client->send($request, $options); } catch (RequestException $e) { throw new ApiException( "[{$e->getCode()}] {$e->getMessage()}", $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? $e->getResponse()->getBody()->getContents() : null ); } $statusCode = $response->getStatusCode(); if ($statusCode < 200 || $statusCode > 299) { throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $request->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\Pipelines', $e->getResponseHeaders() ); $e->setResponseObject($data); break; case 400: $data = ObjectSerializer::deserialize( $e->getResponseBody(), '\Brevo\Client\Model\ErrorModel', $e->getResponseHeaders() ); $e->setResponseObject($data); break; } throw $e; } } /** * Operation crmPipelineDetailsPipelineIDGetAsync * * Get a pipeline * * @param string $pipelineID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsPipelineIDGetAsync($pipelineID) { return $this->crmPipelineDetailsPipelineIDGetAsyncWithHttpInfo($pipelineID) ->then( function ($response) { return $response[0]; } ); } /** * Operation crmPipelineDetailsPipelineIDGetAsyncWithHttpInfo * * Get a pipeline * * @param string $pipelineID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Promise\PromiseInterface */ public function crmPipelineDetailsPipelineIDGetAsyncWithHttpInfo($pipelineID) { $returnType = '\Brevo\Client\Model\Pipelines'; $request = $this->crmPipelineDetailsPipelineIDGetRequest($pipelineID); return $this->client ->sendAsync($request, $this->createHttpClientOption()) ->then( function ($response) use ($returnType) { $responseBody = $response->getBody(); if ($returnType === '\SplFileObject') { $content = $responseBody; //stream goes to serializer } else { $content = $responseBody->getContents(); if ($returnType !== 'string') { $content = json_decode($content); } } return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), $response->getHeaders() ]; }, function ($exception) { $response = $exception->getResponse(); $statusCode = $response->getStatusCode(); throw new ApiException( sprintf( '[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri() ), $statusCode, $response->getHeaders(), $response->getBody() ); } ); } /** * Create request for operation 'crmPipelineDetailsPipelineIDGet' * * @param string $pipelineID (required) * * @throws \InvalidArgumentException * @return \GuzzleHttp\Psr7\Request */ protected function crmPipelineDetailsPipelineIDGetRequest($pipelineID) { // verify the required parameter 'pipelineID' is set if ($pipelineID === null || (is_array($pipelineID) && count($pipelineID) === 0)) { throw new \InvalidArgumentException( 'Missing the required parameter $pipelineID when calling crmPipelineDetailsPipelineIDGet' ); } $resourcePath = '/crm/pipeline/details/{pipelineID}'; $formParams = []; $queryParams = []; $headerParams = []; $httpBody = ''; $multipart = false; // path params if ($pipelineID !== null) { $resourcePath = str_replace( '{' . 'pipelineID' . '}', ObjectSerializer::toPathValue($pipelineID), $resourcePath ); } // body params $_tempBody = null; if ($multipart) { $headers = $this->headerSelector->selectHeadersForMultipart( ['application/json'] ); } else { $headers = $this->headerSelector->selectHeaders( ['application/json'], ['application/json'] ); } // for model (json/xml) if (isset($_tempBody)) { // $_tempBody is the method argument, if present $httpBody = $_tempBody; if($headers['Content-Type'] === 'application/json') { // \stdClass has no __toString(), so we should encode it manually if ($httpBody instanceof \stdClass) { $httpBody = \GuzzleHttp\json_encode($httpBody); } // array has no __toString(), so we should encode it manually if(is_array($httpBody)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody)); } } } elseif (count($formParams) > 0) { if ($multipart) { $multipartContents = []; foreach ($formParams as $formParamName => $formParamValue) { $multipartContents[] = [ 'name' => $formParamName, 'contents' => $formParamValue ]; } // for HTTP post (form) $httpBody = new MultipartStream($multipartContents); } elseif ($headers['Content-Type'] === 'application/json') { $httpBody = \GuzzleHttp\json_encode($formParams); } else { // for HTTP post (form) $httpBody = \GuzzleHttp\Psr7\Query::build($formParams); } } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('api-key'); if ($apiKey !== null) { $headers['api-key'] = $apiKey; } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('partner-key'); if ($apiKey !== null) { $headers['partner-key'] = $apiKey; } $defaultHeaders = []; if ($this->config->getUserAgent()) { $defaultHeaders['User-Agent'] = $this->config->getUserAgent(); } $headers = array_merge( $defaultHeaders, $headerParams, $headers ); $query = \GuzzleHttp\Psr7\Query::build($queryParams); return new Request( 'GET', $this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''), $headers, $httpBody ); } /** * Create http client option * * @throws \RuntimeException on file opening failure * @return array of http client options */ protected function createHttpClientOption() { $options = []; if ($this->config->getDebug()) { $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a'); if (!$options[RequestOptions::DEBUG]) { throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile()); } } return $options; } } brevo-php/lib/ApiException.php 0000644 00000007050 15021222673 0012317 0 ustar 00 <?php /** * ApiException * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client; use \Exception; /** * ApiException Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ApiException extends Exception { /** * The HTTP body of the server response either as Json or string. * * @var mixed */ protected $responseBody; /** * The HTTP header of the server response. * * @var string[]|null */ protected $responseHeaders; /** * The deserialized response object * * @var $responseObject; */ protected $responseObject; /** * Constructor * * @param string $message Error message * @param int $code HTTP status code * @param string[]|null $responseHeaders HTTP response header * @param mixed $responseBody HTTP decoded body of the server response either as \stdClass or string */ public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; $this->responseBody = $responseBody; } /** * Gets the HTTP response header * * @return string[]|null HTTP response header */ public function getResponseHeaders() { return $this->responseHeaders; } /** * Gets the HTTP body of the server response either as Json or string * * @return mixed HTTP body of the server response either as \stdClass or string */ public function getResponseBody() { return $this->responseBody; } /** * Sets the deseralized response object (during deserialization) * * @param mixed $obj Deserialized response object * * @return void */ public function setResponseObject($obj) { $this->responseObject = $obj; } /** * Gets the deseralized response object (during deserialization) * * @return mixed the deserialized response object */ public function getResponseObject() { return $this->responseObject; } } brevo-php/lib/Configuration.php 0000644 00000023570 15021222673 0012543 0 ustar 00 <?php /** * Configuration * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client; /** * Configuration Class Doc Comment * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ $GLOBALS['version'] = '1.0.2'; class Configuration { private static $defaultConfiguration; /** * Associate array to store API key(s) * * @var string[] */ protected $apiKeys = []; /** * Associate array to store API prefix (e.g. Bearer) * * @var string[] */ protected $apiKeyPrefixes = []; /** * Access token for OAuth * * @var string */ protected $accessToken = ''; /** * Username for HTTP basic authentication * * @var string */ protected $username = ''; /** * Password for HTTP basic authentication * * @var string */ protected $password = ''; /** * The host * * @var string */ protected $host = 'https://api.brevo.com/v3'; /** * User agent of the HTTP request, set to "PHP-Swagger" by default * * @var string */ protected $userAgent = 'Swagger-Codegen/1.0.0/php'; /** * Debug switch (default set to false) * * @var bool */ protected $debug = false; /** * Debug file location (log to STDOUT by default) * * @var string */ protected $debugFile = 'php://output'; /** * Debug file location (log to STDOUT by default) * * @var string */ protected $tempFolderPath; /** * Constructor */ public function __construct() { $this->tempFolderPath = sys_get_temp_dir(); $this->userAgent = 'brevo_clientAPI/v' . $GLOBALS['version'] . '/php'; } /** * Sets API key * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $key API key or token * * @return $this */ public function setApiKey($apiKeyIdentifier, $key) { $this->apiKeys[$apiKeyIdentifier] = $key; return $this; } /** * Gets API key * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * * @return string API key or token */ public function getApiKey($apiKeyIdentifier) { return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null; } /** * Sets the prefix for API key (e.g. Bearer) * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $prefix API key prefix, e.g. Bearer * * @return $this */ public function setApiKeyPrefix($apiKeyIdentifier, $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; return $this; } /** * Gets API key prefix * * @param string $apiKeyIdentifier API key identifier (authentication scheme) * * @return string */ public function getApiKeyPrefix($apiKeyIdentifier) { return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null; } /** * Sets the access token for OAuth * * @param string $accessToken Token for OAuth * * @return $this */ public function setAccessToken($accessToken) { $this->accessToken = $accessToken; return $this; } /** * Gets the access token for OAuth * * @return string Access token for OAuth */ public function getAccessToken() { return $this->accessToken; } /** * Sets the username for HTTP basic authentication * * @param string $username Username for HTTP basic authentication * * @return $this */ public function setUsername($username) { $this->username = $username; return $this; } /** * Gets the username for HTTP basic authentication * * @return string Username for HTTP basic authentication */ public function getUsername() { return $this->username; } /** * Sets the password for HTTP basic authentication * * @param string $password Password for HTTP basic authentication * * @return $this */ public function setPassword($password) { $this->password = $password; return $this; } /** * Gets the password for HTTP basic authentication * * @return string Password for HTTP basic authentication */ public function getPassword() { return $this->password; } /** * Sets the host * * @param string $host Host * * @return $this */ public function setHost($host) { $this->host = $host; return $this; } /** * Gets the host * * @return string Host */ public function getHost() { return $this->host; } /** * Sets the user agent of the api client * * @param string $userAgent the user agent of the api client * * @throws \InvalidArgumentException * @return $this */ public function setUserAgent($userAgent) { if (!is_string($userAgent)) { throw new \InvalidArgumentException('User-agent must be a string.'); } $this->userAgent = $userAgent; return $this; } /** * Gets the user agent of the api client * * @return string user agent */ public function getUserAgent() { return $this->userAgent; } /** * Sets debug flag * * @param bool $debug Debug flag * * @return $this */ public function setDebug($debug) { $this->debug = $debug; return $this; } /** * Gets the debug flag * * @return bool */ public function getDebug() { return $this->debug; } /** * Sets the debug file * * @param string $debugFile Debug file * * @return $this */ public function setDebugFile($debugFile) { $this->debugFile = $debugFile; return $this; } /** * Gets the debug file * * @return string */ public function getDebugFile() { return $this->debugFile; } /** * Sets the temp folder path * * @param string $tempFolderPath Temp folder path * * @return $this */ public function setTempFolderPath($tempFolderPath) { $this->tempFolderPath = $tempFolderPath; return $this; } /** * Gets the temp folder path * * @return string Temp folder path */ public function getTempFolderPath() { return $this->tempFolderPath; } /** * Gets the default configuration instance * * @return Configuration */ public static function getDefaultConfiguration() { if (self::$defaultConfiguration === null) { self::$defaultConfiguration = new Configuration(); } return self::$defaultConfiguration; } /** * Sets the detault configuration instance * * @param Configuration $config An instance of the Configuration Object * * @return void */ public static function setDefaultConfiguration(Configuration $config) { self::$defaultConfiguration = $config; } /** * Gets the essential information for debugging * * @return string The report for debugging */ public static function toDebugReport() { $report = 'PHP SDK (Brevo\Client) Debug Report:' . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; $report .= ' OpenAPI Spec Version: 3.0.0' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; } /** * Get API key (with prefix if set) * * @param string $apiKeyIdentifier name of apikey * * @return string API key with the prefix */ public function getApiKeyWithPrefix($apiKeyIdentifier) { $prefix = $this->getApiKeyPrefix($apiKeyIdentifier); $apiKey = $this->getApiKey($apiKeyIdentifier); if ($apiKey === null) { return null; } if ($prefix === null) { $keyWithPrefix = $apiKey; } else { $keyWithPrefix = $prefix . ' ' . $apiKey; } return $keyWithPrefix; } } brevo-php/lib/Model/GetFolderLists.php 0000644 00000017054 15021222673 0013666 0 ustar 00 <?php /** * GetFolderLists * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetFolderLists Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFolderLists implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getFolderLists'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'lists' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'lists' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'lists' => 'lists', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'lists' => 'setLists', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'lists' => 'getLists', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['lists'] = isset($data['lists']) ? $data['lists'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets lists * * @return object[] */ public function getLists() { return $this->container['lists']; } /** * Sets lists * * @param object[] $lists lists * * @return $this */ public function setLists($lists) { $this->container['lists'] = $lists; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of lists in the folder * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAllExternalFeedsFeeds.php 0000644 00000042154 15021222673 0015564 0 ustar 00 <?php /** * GetAllExternalFeedsFeeds * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAllExternalFeedsFeeds Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAllExternalFeedsFeeds implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAllExternalFeeds_feeds'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'authType' => 'string', 'username' => 'string', 'password' => 'string', 'token' => 'string', 'headers' => '\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]', 'maxRetries' => 'int', 'cache' => 'bool', 'createdAt' => '\DateTime', 'modifiedAt' => '\DateTime' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4', 'name' => null, 'url' => 'url', 'authType' => null, 'username' => null, 'password' => null, 'token' => null, 'headers' => null, 'maxRetries' => null, 'cache' => null, 'createdAt' => 'date-time', 'modifiedAt' => 'date-time' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'authType' => 'authType', 'username' => 'username', 'password' => 'password', 'token' => 'token', 'headers' => 'headers', 'maxRetries' => 'maxRetries', 'cache' => 'cache', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'authType' => 'setAuthType', 'username' => 'setUsername', 'password' => 'setPassword', 'token' => 'setToken', 'headers' => 'setHeaders', 'maxRetries' => 'setMaxRetries', 'cache' => 'setCache', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'authType' => 'getAuthType', 'username' => 'getUsername', 'password' => 'getPassword', 'token' => 'getToken', 'headers' => 'getHeaders', 'maxRetries' => 'getMaxRetries', 'cache' => 'getCache', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const AUTH_TYPE_BASIC = 'basic'; const AUTH_TYPE_TOKEN = 'token'; const AUTH_TYPE_NO_AUTH = 'noAuth'; /** * Gets allowable values of the enum * * @return string[] */ public function getAuthTypeAllowableValues() { return [ self::AUTH_TYPE_BASIC, self::AUTH_TYPE_TOKEN, self::AUTH_TYPE_NO_AUTH, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['authType'] = isset($data['authType']) ? $data['authType'] : null; $this->container['username'] = isset($data['username']) ? $data['username'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['token'] = isset($data['token']) ? $data['token'] : null; $this->container['headers'] = isset($data['headers']) ? $data['headers'] : null; $this->container['maxRetries'] = isset($data['maxRetries']) ? $data['maxRetries'] : null; $this->container['cache'] = isset($data['cache']) ? $data['cache'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } if ($this->container['authType'] === null) { $invalidProperties[] = "'authType' can't be null"; } $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($this->container['authType']) && !in_array($this->container['authType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['headers'] === null) { $invalidProperties[] = "'headers' can't be null"; } if ($this->container['maxRetries'] === null) { $invalidProperties[] = "'maxRetries' can't be null"; } if (($this->container['maxRetries'] > 5)) { $invalidProperties[] = "invalid value for 'maxRetries', must be smaller than or equal to 5."; } if (($this->container['maxRetries'] < 0)) { $invalidProperties[] = "invalid value for 'maxRetries', must be bigger than or equal to 0."; } if ($this->container['cache'] === null) { $invalidProperties[] = "'cache' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id ID of the feed * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the feed * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the feed * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets authType * * @return string */ public function getAuthType() { return $this->container['authType']; } /** * Sets authType * * @param string $authType Auth type of the feed: * `basic` * `token` * `noAuth` * * @return $this */ public function setAuthType($authType) { $allowedValues = $this->getAuthTypeAllowableValues(); if (!in_array($authType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['authType'] = $authType; return $this; } /** * Gets username * * @return string */ public function getUsername() { return $this->container['username']; } /** * Sets username * * @param string $username Username for authType `basic` * * @return $this */ public function setUsername($username) { $this->container['username'] = $username; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password Password for authType `basic` * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets token * * @return string */ public function getToken() { return $this->container['token']; } /** * Sets token * * @param string $token Token for authType `token` * * @return $this */ public function setToken($token) { $this->container['token'] = $token; return $this; } /** * Gets headers * * @return \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] */ public function getHeaders() { return $this->container['headers']; } /** * Sets headers * * @param \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] $headers Custom headers for the feed * * @return $this */ public function setHeaders($headers) { $this->container['headers'] = $headers; return $this; } /** * Gets maxRetries * * @return int */ public function getMaxRetries() { return $this->container['maxRetries']; } /** * Sets maxRetries * * @param int $maxRetries Maximum number of retries on the feed url * * @return $this */ public function setMaxRetries($maxRetries) { if (($maxRetries > 5)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling GetAllExternalFeedsFeeds., must be smaller than or equal to 5.'); } if (($maxRetries < 0)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling GetAllExternalFeedsFeeds., must be bigger than or equal to 0.'); } $this->container['maxRetries'] = $maxRetries; return $this; } /** * Gets cache * * @return bool */ public function getCache() { return $this->container['cache']; } /** * Sets cache * * @param bool $cache Toggle caching of feed url response * * @return $this */ public function setCache($cache) { $this->container['cache'] = $cache; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Datetime on which the feed was created * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return \DateTime */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param \DateTime $modifiedAt Datetime on which the feed was modified * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateChildDomain.php 0000644 00000016034 15021222673 0014307 0 ustar 00 <?php /** * UpdateChildDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateChildDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChildDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateChildDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Value for the sender domain that will replace the existing domain * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSmtpTemplate.php 0000644 00000034252 15021222673 0014536 0 ustar 00 <?php /** * CreateSmtpTemplate * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSmtpTemplate Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSmtpTemplate'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'tag' => 'string', 'sender' => '\Brevo\Client\Model\CreateSmtpTemplateSender', 'templateName' => 'string', 'htmlContent' => 'string', 'htmlUrl' => 'string', 'subject' => 'string', 'replyTo' => 'string', 'toField' => 'string', 'attachmentUrl' => 'string', 'isActive' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'tag' => null, 'sender' => null, 'templateName' => null, 'htmlContent' => null, 'htmlUrl' => 'url', 'subject' => null, 'replyTo' => 'email', 'toField' => null, 'attachmentUrl' => 'url', 'isActive' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'tag' => 'tag', 'sender' => 'sender', 'templateName' => 'templateName', 'htmlContent' => 'htmlContent', 'htmlUrl' => 'htmlUrl', 'subject' => 'subject', 'replyTo' => 'replyTo', 'toField' => 'toField', 'attachmentUrl' => 'attachmentUrl', 'isActive' => 'isActive' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'tag' => 'setTag', 'sender' => 'setSender', 'templateName' => 'setTemplateName', 'htmlContent' => 'setHtmlContent', 'htmlUrl' => 'setHtmlUrl', 'subject' => 'setSubject', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'attachmentUrl' => 'setAttachmentUrl', 'isActive' => 'setIsActive' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'tag' => 'getTag', 'sender' => 'getSender', 'templateName' => 'getTemplateName', 'htmlContent' => 'getHtmlContent', 'htmlUrl' => 'getHtmlUrl', 'subject' => 'getSubject', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'attachmentUrl' => 'getAttachmentUrl', 'isActive' => 'getIsActive' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['templateName'] = isset($data['templateName']) ? $data['templateName'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['htmlUrl'] = isset($data['htmlUrl']) ? $data['htmlUrl'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['attachmentUrl'] = isset($data['attachmentUrl']) ? $data['attachmentUrl'] : null; $this->container['isActive'] = isset($data['isActive']) ? $data['isActive'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['templateName'] === null) { $invalidProperties[] = "'templateName' can't be null"; } if ($this->container['subject'] === null) { $invalidProperties[] = "'subject' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the template * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\CreateSmtpTemplateSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\CreateSmtpTemplateSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets templateName * * @return string */ public function getTemplateName() { return $this->container['templateName']; } /** * Sets templateName * * @param string $templateName Name of the template * * @return $this */ public function setTemplateName($templateName) { $this->container['templateName'] = $templateName; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets htmlUrl * * @return string */ public function getHtmlUrl() { return $this->container['htmlUrl']; } /** * Sets htmlUrl * * @param string $htmlUrl Url which contents the body of the email message. REQUIRED if htmlContent is empty * * @return $this */ public function setHtmlUrl($htmlUrl) { $this->container['htmlUrl'] = $htmlUrl; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the template * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email on which campaign recipients will be able to reply to * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets attachmentUrl * * @return string */ public function getAttachmentUrl() { return $this->container['attachmentUrl']; } /** * Sets attachmentUrl * * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * * @return $this */ public function setAttachmentUrl($attachmentUrl) { $this->container['attachmentUrl'] = $attachmentUrl; return $this; } /** * Gets isActive * * @return bool */ public function getIsActive() { return $this->container['isActive']; } /** * Sets isActive * * @param bool $isActive Status of template. isActive = true means template is active and isActive = false means template is inactive * * @return $this */ public function setIsActive($isActive) { $this->container['isActive'] = $isActive; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/TaskReminder.php 0000644 00000023275 15021222673 0013366 0 ustar 00 <?php /** * TaskReminder * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * TaskReminder Class Doc Comment * * @category Class * @description Task reminder date/time for a task * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskReminder implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'TaskReminder'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'int', 'unit' => 'string', 'types' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => null, 'unit' => null, 'types' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'unit' => 'unit', 'types' => 'types' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'unit' => 'setUnit', 'types' => 'setTypes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'unit' => 'getUnit', 'types' => 'getTypes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const UNIT_MINUTES = 'minutes'; const UNIT_HOURS = 'hours'; const UNIT_WEEKS = 'weeks'; const UNIT_DAYS = 'days'; /** * Gets allowable values of the enum * * @return string[] */ public function getUnitAllowableValues() { return [ self::UNIT_MINUTES, self::UNIT_HOURS, self::UNIT_WEEKS, self::UNIT_DAYS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['unit'] = isset($data['unit']) ? $data['unit'] : null; $this->container['types'] = isset($data['types']) ? $data['types'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } if ($this->container['unit'] === null) { $invalidProperties[] = "'unit' can't be null"; } $allowedValues = $this->getUnitAllowableValues(); if (!is_null($this->container['unit']) && !in_array($this->container['unit'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'unit', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['types'] === null) { $invalidProperties[] = "'types' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return int */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param int $value Value of time unit before reminder is to be sent * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets unit * * @return string */ public function getUnit() { return $this->container['unit']; } /** * Sets unit * * @param string $unit Unit of time before reminder is to be sent * * @return $this */ public function setUnit($unit) { $allowedValues = $this->getUnitAllowableValues(); if (!in_array($unit, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'unit', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['unit'] = $unit; return $this; } /** * Gets types * * @return string[] */ public function getTypes() { return $this->container['types']; } /** * Sets types * * @param string[] $types Type of task reminder e.g email, push * * @return $this */ public function setTypes($types) { $this->container['types'] = $types; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RemainingCreditModelReseller.php 0000644 00000017545 15021222673 0016524 0 ustar 00 <?php /** * RemainingCreditModelReseller * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RemainingCreditModelReseller Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModelReseller implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'remainingCreditModel_reseller'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sms' => 'double', 'email' => 'double' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sms' => 'double', 'email' => 'double' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sms' => 'sms', 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sms' => 'setSms', 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sms' => 'getSms', 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sms'] === null) { $invalidProperties[] = "'sms' can't be null"; } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sms * * @return double */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param double $sms SMS Credits remaining for reseller account * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets email * * @return double */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param double $email Email Credits remaining for reseller account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSubAccount.php 0000644 00000025100 15021222673 0014155 0 ustar 00 <?php /** * CreateSubAccount * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSubAccount Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSubAccount implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSubAccount'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'companyName' => 'string', 'email' => 'string', 'language' => 'string', 'timezone' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'companyName' => null, 'email' => null, 'language' => null, 'timezone' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'companyName' => 'companyName', 'email' => 'email', 'language' => 'language', 'timezone' => 'timezone' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'companyName' => 'setCompanyName', 'email' => 'setEmail', 'language' => 'setLanguage', 'timezone' => 'setTimezone' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'companyName' => 'getCompanyName', 'email' => 'getEmail', 'language' => 'getLanguage', 'timezone' => 'getTimezone' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const LANGUAGE_EN = 'en'; const LANGUAGE_FR = 'fr'; const LANGUAGE_IT = 'it'; const LANGUAGE_ES = 'es'; const LANGUAGE_PT = 'pt'; const LANGUAGE_DE = 'de'; /** * Gets allowable values of the enum * * @return string[] */ public function getLanguageAllowableValues() { return [ self::LANGUAGE_EN, self::LANGUAGE_FR, self::LANGUAGE_IT, self::LANGUAGE_ES, self::LANGUAGE_PT, self::LANGUAGE_DE, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['language'] = isset($data['language']) ? $data['language'] : null; $this->container['timezone'] = isset($data['timezone']) ? $data['timezone'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['companyName'] === null) { $invalidProperties[] = "'companyName' can't be null"; } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($this->container['language']) && !in_array($this->container['language'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Set the name of the sub-account company * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address for the organization * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language Set the language of the sub-account * * @return $this */ public function setLanguage($language) { $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($language) && !in_array($language, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['language'] = $language; return $this; } /** * Gets timezone * * @return string */ public function getTimezone() { return $this->container['timezone']; } /** * Sets timezone * * @param string $timezone Set the timezone of the sub-account * * @return $this */ public function setTimezone($timezone) { $this->container['timezone'] = $timezone; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSmtpEmail.php 0000644 00000017374 15021222673 0014020 0 ustar 00 <?php /** * CreateSmtpEmail * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSmtpEmail Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpEmail implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSmtpEmail'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'messageId' => 'string', 'messageIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'messageId' => null, 'messageIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'messageId' => 'messageId', 'messageIds' => 'messageIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'messageId' => 'setMessageId', 'messageIds' => 'setMessageIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'messageId' => 'getMessageId', 'messageIds' => 'getMessageIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['messageIds'] = isset($data['messageIds']) ? $data['messageIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message ID of the transactional email sent * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets messageIds * * @return string[] */ public function getMessageIds() { return $this->container['messageIds']; } /** * Sets messageIds * * @param string[] $messageIds messageIds * * @return $this */ public function setMessageIds($messageIds) { $this->container['messageIds'] = $messageIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetFolders.php 0000644 00000017124 15021222673 0013030 0 ustar 00 <?php /** * GetFolders * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetFolders Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFolders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getFolders'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'folders' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'folders' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'folders' => 'folders', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'folders' => 'setFolders', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'folders' => 'getFolders', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['folders'] = isset($data['folders']) ? $data['folders'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets folders * * @return object[] */ public function getFolders() { return $this->container['folders']; } /** * Sets folders * * @param object[] $folders folders * * @return $this */ public function setFolders($folders) { $this->container['folders'] = $folders; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of folders available in your account * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSmsCampaignRecipients.php 0000644 00000020070 15021222673 0016340 0 ustar 00 <?php /** * CreateSmsCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSmsCampaignRecipients Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmsCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSmsCampaign_recipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'listIds' => 'int[]', 'exclusionListIds' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'listIds' => 'int64', 'exclusionListIds' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'listIds' => 'listIds', 'exclusionListIds' => 'exclusionListIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'listIds' => 'setListIds', 'exclusionListIds' => 'setExclusionListIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'listIds' => 'getListIds', 'exclusionListIds' => 'getExclusionListIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['exclusionListIds'] = isset($data['exclusionListIds']) ? $data['exclusionListIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['listIds'] === null) { $invalidProperties[] = "'listIds' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets exclusionListIds * * @return int[] */ public function getExclusionListIds() { return $this->container['exclusionListIds']; } /** * Sets exclusionListIds * * @param int[] $exclusionListIds List ids which have to be excluded from a campaign * * @return $this */ public function setExclusionListIds($exclusionListIds) { $this->container['exclusionListIds'] = $exclusionListIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateSmtpTemplateSender.php 0000644 00000021152 15021222673 0015711 0 ustar 00 <?php /** * UpdateSmtpTemplateSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateSmtpTemplateSender Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmtpTemplateSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateSmtpTemplate_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the sender * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email of the sender * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body1.php 0000644 00000034014 15021222673 0011745 0 ustar 00 <?php /** * Body1 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body1 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body1 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_1'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'duration' => 'int', 'taskTypeId' => 'string', 'date' => '\DateTime', 'notes' => 'string', 'done' => 'bool', 'assignToId' => 'string', 'contactsIds' => 'int[]', 'dealsIds' => 'string[]', 'companiesIds' => 'string[]', 'reminder' => '\Brevo\Client\Model\TaskReminder' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'duration' => null, 'taskTypeId' => null, 'date' => 'date-time', 'notes' => null, 'done' => null, 'assignToId' => null, 'contactsIds' => null, 'dealsIds' => null, 'companiesIds' => null, 'reminder' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'duration' => 'duration', 'taskTypeId' => 'taskTypeId', 'date' => 'date', 'notes' => 'notes', 'done' => 'done', 'assignToId' => 'assignToId', 'contactsIds' => 'contactsIds', 'dealsIds' => 'dealsIds', 'companiesIds' => 'companiesIds', 'reminder' => 'reminder' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'duration' => 'setDuration', 'taskTypeId' => 'setTaskTypeId', 'date' => 'setDate', 'notes' => 'setNotes', 'done' => 'setDone', 'assignToId' => 'setAssignToId', 'contactsIds' => 'setContactsIds', 'dealsIds' => 'setDealsIds', 'companiesIds' => 'setCompaniesIds', 'reminder' => 'setReminder' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'duration' => 'getDuration', 'taskTypeId' => 'getTaskTypeId', 'date' => 'getDate', 'notes' => 'getNotes', 'done' => 'getDone', 'assignToId' => 'getAssignToId', 'contactsIds' => 'getContactsIds', 'dealsIds' => 'getDealsIds', 'companiesIds' => 'getCompaniesIds', 'reminder' => 'getReminder' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['duration'] = isset($data['duration']) ? $data['duration'] : null; $this->container['taskTypeId'] = isset($data['taskTypeId']) ? $data['taskTypeId'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['notes'] = isset($data['notes']) ? $data['notes'] : null; $this->container['done'] = isset($data['done']) ? $data['done'] : null; $this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null; $this->container['contactsIds'] = isset($data['contactsIds']) ? $data['contactsIds'] : null; $this->container['dealsIds'] = isset($data['dealsIds']) ? $data['dealsIds'] : null; $this->container['companiesIds'] = isset($data['companiesIds']) ? $data['companiesIds'] : null; $this->container['reminder'] = isset($data['reminder']) ? $data['reminder'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['taskTypeId'] === null) { $invalidProperties[] = "'taskTypeId' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of task * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets duration * * @return int */ public function getDuration() { return $this->container['duration']; } /** * Sets duration * * @param int $duration Duration of task in milliseconds [1 minute = 60000 ms] * * @return $this */ public function setDuration($duration) { $this->container['duration'] = $duration; return $this; } /** * Gets taskTypeId * * @return string */ public function getTaskTypeId() { return $this->container['taskTypeId']; } /** * Sets taskTypeId * * @param string $taskTypeId Id for type of task e.g Call / Email / Meeting etc. * * @return $this */ public function setTaskTypeId($taskTypeId) { $this->container['taskTypeId'] = $taskTypeId; return $this; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Task date/time * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets notes * * @return string */ public function getNotes() { return $this->container['notes']; } /** * Sets notes * * @param string $notes Notes added to a task * * @return $this */ public function setNotes($notes) { $this->container['notes'] = $notes; return $this; } /** * Gets done * * @return bool */ public function getDone() { return $this->container['done']; } /** * Sets done * * @param bool $done Task marked as done * * @return $this */ public function setDone($done) { $this->container['done'] = $done; return $this; } /** * Gets assignToId * * @return string */ public function getAssignToId() { return $this->container['assignToId']; } /** * Sets assignToId * * @param string $assignToId User id to whom task is assigned * * @return $this */ public function setAssignToId($assignToId) { $this->container['assignToId'] = $assignToId; return $this; } /** * Gets contactsIds * * @return int[] */ public function getContactsIds() { return $this->container['contactsIds']; } /** * Sets contactsIds * * @param int[] $contactsIds Contact ids for contacts linked to this task * * @return $this */ public function setContactsIds($contactsIds) { $this->container['contactsIds'] = $contactsIds; return $this; } /** * Gets dealsIds * * @return string[] */ public function getDealsIds() { return $this->container['dealsIds']; } /** * Sets dealsIds * * @param string[] $dealsIds Deal ids for deals a task is linked to * * @return $this */ public function setDealsIds($dealsIds) { $this->container['dealsIds'] = $dealsIds; return $this; } /** * Gets companiesIds * * @return string[] */ public function getCompaniesIds() { return $this->container['companiesIds']; } /** * Sets companiesIds * * @param string[] $companiesIds Companies ids for companies a task is linked to * * @return $this */ public function setCompaniesIds($companiesIds) { $this->container['companiesIds'] = $companiesIds; return $this; } /** * Gets reminder * * @return \Brevo\Client\Model\TaskReminder */ public function getReminder() { return $this->container['reminder']; } /** * Sets reminder * * @param \Brevo\Client\Model\TaskReminder $reminder reminder * * @return $this */ public function setReminder($reminder) { $this->container['reminder'] = $reminder; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacEmailContentEvents.php 0000644 00000017530 15021222673 0016516 0 ustar 00 <?php /** * GetTransacEmailContentEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacEmailContentEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailContentEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacEmailContent_events'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'time' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'time' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'time' => 'time' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'time' => 'setTime' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'time' => 'getTime' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['time'] = isset($data['time']) ? $data['time'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['time'] === null) { $invalidProperties[] = "'time' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the event that occurred on the sent email * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets time * * @return string */ public function getTime() { return $this->container['time']; } /** * Sets time * * @param string $time Time at which the event occurred * * @return $this */ public function setTime($time) { $this->container['time'] = $time; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAttributesAttributes.php 0000644 00000031107 15021222673 0015624 0 ustar 00 <?php /** * GetAttributesAttributes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAttributesAttributes Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributesAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAttributes_attributes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'category' => 'string', 'type' => 'string', 'enumeration' => '\Brevo\Client\Model\GetAttributesEnumeration[]', 'calculatedValue' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'category' => null, 'type' => null, 'enumeration' => null, 'calculatedValue' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'category' => 'category', 'type' => 'type', 'enumeration' => 'enumeration', 'calculatedValue' => 'calculatedValue' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'category' => 'setCategory', 'type' => 'setType', 'enumeration' => 'setEnumeration', 'calculatedValue' => 'setCalculatedValue' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'category' => 'getCategory', 'type' => 'getType', 'enumeration' => 'getEnumeration', 'calculatedValue' => 'getCalculatedValue' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CATEGORY_NORMAL = 'normal'; const CATEGORY_TRANSACTIONAL = 'transactional'; const CATEGORY_CATEGORY = 'category'; const CATEGORY_CALCULATED = 'calculated'; const CATEGORY__GLOBAL = 'global'; const TYPE_TEXT = 'text'; const TYPE_DATE = 'date'; const TYPE_FLOAT = 'float'; const TYPE_ID = 'id'; const TYPE_BOOLEAN = 'boolean'; /** * Gets allowable values of the enum * * @return string[] */ public function getCategoryAllowableValues() { return [ self::CATEGORY_NORMAL, self::CATEGORY_TRANSACTIONAL, self::CATEGORY_CATEGORY, self::CATEGORY_CALCULATED, self::CATEGORY__GLOBAL, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_TEXT, self::TYPE_DATE, self::TYPE_FLOAT, self::TYPE_ID, self::TYPE_BOOLEAN, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['category'] = isset($data['category']) ? $data['category'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['enumeration'] = isset($data['enumeration']) ? $data['enumeration'] : null; $this->container['calculatedValue'] = isset($data['calculatedValue']) ? $data['calculatedValue'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['category'] === null) { $invalidProperties[] = "'category' can't be null"; } $allowedValues = $this->getCategoryAllowableValues(); if (!is_null($this->container['category']) && !in_array($this->container['category'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'category', must be one of '%s'", implode("', '", $allowedValues) ); } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the attribute * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets category * * @return string */ public function getCategory() { return $this->container['category']; } /** * Sets category * * @param string $category Category of the attribute * * @return $this */ public function setCategory($category) { $allowedValues = $this->getCategoryAllowableValues(); if (!in_array($category, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'category', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['category'] = $category; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of the attribute * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets enumeration * * @return \Brevo\Client\Model\GetAttributesEnumeration[] */ public function getEnumeration() { return $this->container['enumeration']; } /** * Sets enumeration * * @param \Brevo\Client\Model\GetAttributesEnumeration[] $enumeration Parameter only available for \"category\" type attributes. * * @return $this */ public function setEnumeration($enumeration) { $this->container['enumeration'] = $enumeration; return $this; } /** * Gets calculatedValue * * @return string */ public function getCalculatedValue() { return $this->container['calculatedValue']; } /** * Sets calculatedValue * * @param string $calculatedValue Calculated value formula * * @return $this */ public function setCalculatedValue($calculatedValue) { $this->container['calculatedValue'] = $calculatedValue; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailSender.php 0000644 00000021435 15021222673 0014640 0 ustar 00 <?php /** * SendSmtpEmailSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailSender Class Doc Comment * * @category Class * @description Mandatory if `templateId` is not passed. Pass `name` (optional) and `email` OR `id` of sender from which emails will be sent. `name` will be ignored if passed along with sender `id`. For example, {\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"} or {\"id\":2} * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the sender from which the emails will be sent. Maximum allowed characters are 70. Applicable only when email is passed. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email of the sender from which the emails will be sent. Mandatory if sender id is not passed. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the sender from which the emails will be sent. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). Mandatory if email is not passed. * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateProducts.php 0000644 00000032315 15021222673 0015063 0 ustar 00 <?php /** * CreateUpdateProducts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateProducts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateProducts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateProducts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => 'string[]', 'parentId' => 'string', 'metaInfo' => 'map[string,string]', 'deletedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => null, 'parentId' => 'string', 'metaInfo' => null, 'deletedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'imageUrl' => 'imageUrl', 'sku' => 'sku', 'price' => 'price', 'categories' => 'categories', 'parentId' => 'parentId', 'metaInfo' => 'metaInfo', 'deletedAt' => 'deletedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'imageUrl' => 'setImageUrl', 'sku' => 'setSku', 'price' => 'setPrice', 'categories' => 'setCategories', 'parentId' => 'setParentId', 'metaInfo' => 'setMetaInfo', 'deletedAt' => 'setDeletedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'imageUrl' => 'getImageUrl', 'sku' => 'getSku', 'price' => 'getPrice', 'categories' => 'getCategories', 'parentId' => 'getParentId', 'metaInfo' => 'getMetaInfo', 'deletedAt' => 'getDeletedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['imageUrl'] = isset($data['imageUrl']) ? $data['imageUrl'] : null; $this->container['sku'] = isset($data['sku']) ? $data['sku'] : null; $this->container['price'] = isset($data['price']) ? $data['price'] : null; $this->container['categories'] = isset($data['categories']) ? $data['categories'] : null; $this->container['parentId'] = isset($data['parentId']) ? $data['parentId'] : null; $this->container['metaInfo'] = isset($data['metaInfo']) ? $data['metaInfo'] : null; $this->container['deletedAt'] = isset($data['deletedAt']) ? $data['deletedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Product ID for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Mandatory in case of creation**. Name of the product for which you requested the details * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the product * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets imageUrl * * @return string */ public function getImageUrl() { return $this->container['imageUrl']; } /** * Sets imageUrl * * @param string $imageUrl Absolute URL to the cover image of the product * * @return $this */ public function setImageUrl($imageUrl) { $this->container['imageUrl'] = $imageUrl; return $this; } /** * Gets sku * * @return string */ public function getSku() { return $this->container['sku']; } /** * Sets sku * * @param string $sku Product identifier from the shop * * @return $this */ public function setSku($sku) { $this->container['sku'] = $sku; return $this; } /** * Gets price * * @return float */ public function getPrice() { return $this->container['price']; } /** * Sets price * * @param float $price Price of the product * * @return $this */ public function setPrice($price) { $this->container['price'] = $price; return $this; } /** * Gets categories * * @return string[] */ public function getCategories() { return $this->container['categories']; } /** * Sets categories * * @param string[] $categories Category ID-s of the product * * @return $this */ public function setCategories($categories) { $this->container['categories'] = $categories; return $this; } /** * Gets parentId * * @return string */ public function getParentId() { return $this->container['parentId']; } /** * Sets parentId * * @param string $parentId Parent product id of the product * * @return $this */ public function setParentId($parentId) { $this->container['parentId'] = $parentId; return $this; } /** * Gets metaInfo * * @return map[string,string] */ public function getMetaInfo() { return $this->container['metaInfo']; } /** * Sets metaInfo * * @param map[string,string] $metaInfo Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. * * @return $this */ public function setMetaInfo($metaInfo) { $this->container['metaInfo'] = $metaInfo; return $this; } /** * Gets deletedAt * * @return string */ public function getDeletedAt() { return $this->container['deletedAt']; } /** * Sets deletedAt * * @param string $deletedAt UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database * * @return $this */ public function setDeletedAt($deletedAt) { $this->container['deletedAt'] = $deletedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ComponentItems.php 0000644 00000016752 15021222673 0013744 0 ustar 00 <?php /** * ComponentItems * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ComponentItems Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ComponentItems implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'componentItems'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'type' => 'string', 'text' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'type' => null, 'text' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'type' => 'type', 'text' => 'text' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'type' => 'setType', 'text' => 'setText' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'type' => 'getType', 'text' => 'getText' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type type * * @return $this */ public function setType($type) { $this->container['type'] = $type; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text text * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountRelay.php 0000644 00000020002 15021222673 0014010 0 ustar 00 <?php /** * GetAccountRelay * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountRelay Class Doc Comment * * @category Class * @description Information about your transactional email account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountRelay implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccount_relay'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'enabled' => 'bool', 'data' => '\Brevo\Client\Model\GetAccountRelayData' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'enabled' => null, 'data' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'enabled' => 'enabled', 'data' => 'data' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'enabled' => 'setEnabled', 'data' => 'setData' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'enabled' => 'getEnabled', 'data' => 'getData' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['enabled'] = isset($data['enabled']) ? $data['enabled'] : null; $this->container['data'] = isset($data['data']) ? $data['data'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['enabled'] === null) { $invalidProperties[] = "'enabled' can't be null"; } if ($this->container['data'] === null) { $invalidProperties[] = "'data' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets enabled * * @return bool */ public function getEnabled() { return $this->container['enabled']; } /** * Sets enabled * * @param bool $enabled Status of your transactional email Account (true=Enabled, false=Disabled) * * @return $this */ public function setEnabled($enabled) { $this->container['enabled'] = $enabled; return $this; } /** * Gets data * * @return \Brevo\Client\Model\GetAccountRelayData */ public function getData() { return $this->container['data']; } /** * Sets data * * @param \Brevo\Client\Model\GetAccountRelayData $data data * * @return $this */ public function setData($data) { $this->container['data'] = $data; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateBatchContactsContacts.php 0000644 00000034471 15021222673 0016360 0 ustar 00 <?php /** * UpdateBatchContactsContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateBatchContactsContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContactsContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateBatchContacts_contacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'id' => 'int', 'sms' => 'string', 'extId' => 'string', 'attributes' => 'map[string,object]', 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'listIds' => 'int[]', 'unlinkListIds' => 'int[]', 'smtpBlacklistSender' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'id' => 'int64', 'sms' => null, 'extId' => null, 'attributes' => null, 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'listIds' => 'int64', 'unlinkListIds' => 'int64', 'smtpBlacklistSender' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'id' => 'id', 'sms' => 'sms', 'extId' => 'ext_id', 'attributes' => 'attributes', 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'listIds' => 'listIds', 'unlinkListIds' => 'unlinkListIds', 'smtpBlacklistSender' => 'smtpBlacklistSender' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'id' => 'setId', 'sms' => 'setSms', 'extId' => 'setExtId', 'attributes' => 'setAttributes', 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'listIds' => 'setListIds', 'unlinkListIds' => 'setUnlinkListIds', 'smtpBlacklistSender' => 'setSmtpBlacklistSender' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'id' => 'getId', 'sms' => 'getSms', 'extId' => 'getExtId', 'attributes' => 'getAttributes', 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'listIds' => 'getListIds', 'unlinkListIds' => 'getUnlinkListIds', 'smtpBlacklistSender' => 'getSmtpBlacklistSender' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['extId'] = isset($data['extId']) ? $data['extId'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['emailBlacklisted'] = isset($data['emailBlacklisted']) ? $data['emailBlacklisted'] : null; $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['unlinkListIds'] = isset($data['unlinkListIds']) ? $data['unlinkListIds'] : null; $this->container['smtpBlacklistSender'] = isset($data['smtpBlacklistSender']) ? $data['smtpBlacklistSender'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets sms * * @return string */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param string $sms SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets extId * * @return string */ public function getExtId() { return $this->container['extId']; } /** * Sets extId * * @param string $extId Pass your own Id to update ext_id of a contact. * * @return $this */ public function setExtId($extId) { $this->container['extId'] = $extId; return $this; } /** * Gets attributes * * @return map[string,object] */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param map[string,object] $attributes Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in **SMS** field should be passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"}** * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets emailBlacklisted * * @return bool */ public function getEmailBlacklisted() { return $this->container['emailBlacklisted']; } /** * Sets emailBlacklisted * * @param bool $emailBlacklisted Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) * * @return $this */ public function setEmailBlacklisted($emailBlacklisted) { $this->container['emailBlacklisted'] = $emailBlacklisted; return $this; } /** * Gets smsBlacklisted * * @return bool */ public function getSmsBlacklisted() { return $this->container['smsBlacklisted']; } /** * Sets smsBlacklisted * * @param bool $smsBlacklisted Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) * * @return $this */ public function setSmsBlacklisted($smsBlacklisted) { $this->container['smsBlacklisted'] = $smsBlacklisted; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Ids of the lists to add the contact to * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets unlinkListIds * * @return int[] */ public function getUnlinkListIds() { return $this->container['unlinkListIds']; } /** * Sets unlinkListIds * * @param int[] $unlinkListIds Ids of the lists to remove the contact from * * @return $this */ public function setUnlinkListIds($unlinkListIds) { $this->container['unlinkListIds'] = $unlinkListIds; return $this; } /** * Gets smtpBlacklistSender * * @return string[] */ public function getSmtpBlacklistSender() { return $this->container['smtpBlacklistSender']; } /** * Sets smtpBlacklistSender * * @param string[] $smtpBlacklistSender transactional email forbidden sender for contact. Use only for email Contact * * @return $this */ public function setSmtpBlacklistSender($smtpBlacklistSender) { $this->container['smtpBlacklistSender'] = $smtpBlacklistSender; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAggregatedReport.php 0000644 00000036461 15021222673 0014665 0 ustar 00 <?php /** * GetAggregatedReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAggregatedReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAggregatedReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAggregatedReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'range' => 'string', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', 'softBounces' => 'int', 'clicks' => 'int', 'uniqueClicks' => 'int', 'opens' => 'int', 'uniqueOpens' => 'int', 'spamReports' => 'int', 'blocked' => 'int', 'invalid' => 'int', 'unsubscribed' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'range' => null, 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', 'softBounces' => 'int64', 'clicks' => 'int64', 'uniqueClicks' => 'int64', 'opens' => 'int64', 'uniqueOpens' => 'int64', 'spamReports' => 'int64', 'blocked' => 'int64', 'invalid' => 'int64', 'unsubscribed' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'range' => 'range', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'clicks' => 'clicks', 'uniqueClicks' => 'uniqueClicks', 'opens' => 'opens', 'uniqueOpens' => 'uniqueOpens', 'spamReports' => 'spamReports', 'blocked' => 'blocked', 'invalid' => 'invalid', 'unsubscribed' => 'unsubscribed' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'range' => 'setRange', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'clicks' => 'setClicks', 'uniqueClicks' => 'setUniqueClicks', 'opens' => 'setOpens', 'uniqueOpens' => 'setUniqueOpens', 'spamReports' => 'setSpamReports', 'blocked' => 'setBlocked', 'invalid' => 'setInvalid', 'unsubscribed' => 'setUnsubscribed' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'range' => 'getRange', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'clicks' => 'getClicks', 'uniqueClicks' => 'getUniqueClicks', 'opens' => 'getOpens', 'uniqueOpens' => 'getUniqueOpens', 'spamReports' => 'getSpamReports', 'blocked' => 'getBlocked', 'invalid' => 'getInvalid', 'unsubscribed' => 'getUnsubscribed' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['range'] = isset($data['range']) ? $data['range'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['clicks'] = isset($data['clicks']) ? $data['clicks'] : null; $this->container['uniqueClicks'] = isset($data['uniqueClicks']) ? $data['uniqueClicks'] : null; $this->container['opens'] = isset($data['opens']) ? $data['opens'] : null; $this->container['uniqueOpens'] = isset($data['uniqueOpens']) ? $data['uniqueOpens'] : null; $this->container['spamReports'] = isset($data['spamReports']) ? $data['spamReports'] : null; $this->container['blocked'] = isset($data['blocked']) ? $data['blocked'] : null; $this->container['invalid'] = isset($data['invalid']) ? $data['invalid'] : null; $this->container['unsubscribed'] = isset($data['unsubscribed']) ? $data['unsubscribed'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets range * * @return string */ public function getRange() { return $this->container['range']; } /** * Sets range * * @param string $range Time frame of the report * * @return $this */ public function setRange($range) { $this->container['range'] = $range; return $this; } /** * Gets requests * * @return int */ public function getRequests() { return $this->container['requests']; } /** * Sets requests * * @param int $requests Number of requests for the timeframe * * @return $this */ public function setRequests($requests) { $this->container['requests'] = $requests; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered emails for the timeframe * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of hardbounces for the timeframe * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounces for the timeframe * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets clicks * * @return int */ public function getClicks() { return $this->container['clicks']; } /** * Sets clicks * * @param int $clicks Number of clicks for the timeframe * * @return $this */ public function setClicks($clicks) { $this->container['clicks'] = $clicks; return $this; } /** * Gets uniqueClicks * * @return int */ public function getUniqueClicks() { return $this->container['uniqueClicks']; } /** * Sets uniqueClicks * * @param int $uniqueClicks Number of unique clicks for the timeframe * * @return $this */ public function setUniqueClicks($uniqueClicks) { $this->container['uniqueClicks'] = $uniqueClicks; return $this; } /** * Gets opens * * @return int */ public function getOpens() { return $this->container['opens']; } /** * Sets opens * * @param int $opens Number of openings for the timeframe * * @return $this */ public function setOpens($opens) { $this->container['opens'] = $opens; return $this; } /** * Gets uniqueOpens * * @return int */ public function getUniqueOpens() { return $this->container['uniqueOpens']; } /** * Sets uniqueOpens * * @param int $uniqueOpens Number of unique openings for the timeframe * * @return $this */ public function setUniqueOpens($uniqueOpens) { $this->container['uniqueOpens'] = $uniqueOpens; return $this; } /** * Gets spamReports * * @return int */ public function getSpamReports() { return $this->container['spamReports']; } /** * Sets spamReports * * @param int $spamReports Number of complaint (spam report) for the timeframe * * @return $this */ public function setSpamReports($spamReports) { $this->container['spamReports'] = $spamReports; return $this; } /** * Gets blocked * * @return int */ public function getBlocked() { return $this->container['blocked']; } /** * Sets blocked * * @param int $blocked Number of blocked contact emails for the timeframe * * @return $this */ public function setBlocked($blocked) { $this->container['blocked'] = $blocked; return $this; } /** * Gets invalid * * @return int */ public function getInvalid() { return $this->container['invalid']; } /** * Sets invalid * * @param int $invalid Number of invalid emails for the timeframe * * @return $this */ public function setInvalid($invalid) { $this->container['invalid'] = $invalid; return $this; } /** * Gets unsubscribed * * @return int */ public function getUnsubscribed() { return $this->container['unsubscribed']; } /** * Sets unsubscribed * * @param int $unsubscribed Number of unsubscribed emails for the timeframe * * @return $this */ public function setUnsubscribed($unsubscribed) { $this->container['unsubscribed'] = $unsubscribed; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateWhatsAppCampaign.php 0000644 00000025613 15021222673 0015326 0 ustar 00 <?php /** * UpdateWhatsAppCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateWhatsAppCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateWhatsAppCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateWhatsAppCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignName' => 'string', 'campaignStatus' => 'string', 'rescheduleFor' => 'string', 'recipients' => '\Brevo\Client\Model\CreateWhatsAppCampaignRecipients' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignName' => null, 'campaignStatus' => null, 'rescheduleFor' => null, 'recipients' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignName' => 'campaignName', 'campaignStatus' => 'campaignStatus', 'rescheduleFor' => 'rescheduleFor', 'recipients' => 'recipients' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignName' => 'setCampaignName', 'campaignStatus' => 'setCampaignStatus', 'rescheduleFor' => 'setRescheduleFor', 'recipients' => 'setRecipients' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignName' => 'getCampaignName', 'campaignStatus' => 'getCampaignStatus', 'rescheduleFor' => 'getRescheduleFor', 'recipients' => 'getRecipients' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CAMPAIGN_STATUS_SCHEDULED = 'scheduled'; const CAMPAIGN_STATUS_SUSPENDED = 'suspended'; /** * Gets allowable values of the enum * * @return string[] */ public function getCampaignStatusAllowableValues() { return [ self::CAMPAIGN_STATUS_SCHEDULED, self::CAMPAIGN_STATUS_SUSPENDED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignName'] = isset($data['campaignName']) ? $data['campaignName'] : null; $this->container['campaignStatus'] = isset($data['campaignStatus']) ? $data['campaignStatus'] : 'scheduled'; $this->container['rescheduleFor'] = isset($data['rescheduleFor']) ? $data['rescheduleFor'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getCampaignStatusAllowableValues(); if (!is_null($this->container['campaignStatus']) && !in_array($this->container['campaignStatus'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignName * * @return string */ public function getCampaignName() { return $this->container['campaignName']; } /** * Sets campaignName * * @param string $campaignName Name of the campaign * * @return $this */ public function setCampaignName($campaignName) { $this->container['campaignName'] = $campaignName; return $this; } /** * Gets campaignStatus * * @return string */ public function getCampaignStatus() { return $this->container['campaignStatus']; } /** * Sets campaignStatus * * @param string $campaignStatus Status of the campaign * * @return $this */ public function setCampaignStatus($campaignStatus) { $allowedValues = $this->getCampaignStatusAllowableValues(); if (!is_null($campaignStatus) && !in_array($campaignStatus, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['campaignStatus'] = $campaignStatus; return $this; } /** * Gets rescheduleFor * * @return string */ public function getRescheduleFor() { return $this->container['rescheduleFor']; } /** * Sets rescheduleFor * * @param string $rescheduleFor Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign. * * @return $this */ public function setRescheduleFor($rescheduleFor) { $this->container['rescheduleFor'] = $rescheduleFor; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\CreateWhatsAppCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\CreateWhatsAppCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailCc.php 0000644 00000017331 15021222673 0013745 0 ustar 00 <?php /** * SendSmtpEmailCc * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailCc Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailCc implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_cc'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the recipient in cc * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the recipient in cc. Maximum allowed characters are 70. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSender.php 0000644 00000021027 15021222673 0013333 0 ustar 00 <?php /** * CreateSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'ips' => '\Brevo\Client\Model\CreateSenderIps[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'ips' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'ips' => 'ips' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'ips' => 'setIps' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'ips' => 'getIps' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name From Name to use for the sender * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email From email to use for the sender. A verification email will be sent to this address. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets ips * * @return \Brevo\Client\Model\CreateSenderIps[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param \Brevo\Client\Model\CreateSenderIps[] $ips Mandatory in case of dedicated IP, IPs to associate to the sender * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateProduct.php 0000644 00000034010 15021222673 0014672 0 ustar 00 <?php /** * CreateUpdateProduct * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateProduct Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateProduct implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateProduct'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => 'string[]', 'parentId' => 'string', 'metaInfo' => 'map[string,string]', 'updateEnabled' => 'bool', 'deletedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => null, 'parentId' => 'string', 'metaInfo' => null, 'updateEnabled' => null, 'deletedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'imageUrl' => 'imageUrl', 'sku' => 'sku', 'price' => 'price', 'categories' => 'categories', 'parentId' => 'parentId', 'metaInfo' => 'metaInfo', 'updateEnabled' => 'updateEnabled', 'deletedAt' => 'deletedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'imageUrl' => 'setImageUrl', 'sku' => 'setSku', 'price' => 'setPrice', 'categories' => 'setCategories', 'parentId' => 'setParentId', 'metaInfo' => 'setMetaInfo', 'updateEnabled' => 'setUpdateEnabled', 'deletedAt' => 'setDeletedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'imageUrl' => 'getImageUrl', 'sku' => 'getSku', 'price' => 'getPrice', 'categories' => 'getCategories', 'parentId' => 'getParentId', 'metaInfo' => 'getMetaInfo', 'updateEnabled' => 'getUpdateEnabled', 'deletedAt' => 'getDeletedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['imageUrl'] = isset($data['imageUrl']) ? $data['imageUrl'] : null; $this->container['sku'] = isset($data['sku']) ? $data['sku'] : null; $this->container['price'] = isset($data['price']) ? $data['price'] : null; $this->container['categories'] = isset($data['categories']) ? $data['categories'] : null; $this->container['parentId'] = isset($data['parentId']) ? $data['parentId'] : null; $this->container['metaInfo'] = isset($data['metaInfo']) ? $data['metaInfo'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : false; $this->container['deletedAt'] = isset($data['deletedAt']) ? $data['deletedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Product ID for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Mandatory in case of creation**. Name of the product for which you requested the details * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the product * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets imageUrl * * @return string */ public function getImageUrl() { return $this->container['imageUrl']; } /** * Sets imageUrl * * @param string $imageUrl Absolute URL to the cover image of the product * * @return $this */ public function setImageUrl($imageUrl) { $this->container['imageUrl'] = $imageUrl; return $this; } /** * Gets sku * * @return string */ public function getSku() { return $this->container['sku']; } /** * Sets sku * * @param string $sku Product identifier from the shop * * @return $this */ public function setSku($sku) { $this->container['sku'] = $sku; return $this; } /** * Gets price * * @return float */ public function getPrice() { return $this->container['price']; } /** * Sets price * * @param float $price Price of the product * * @return $this */ public function setPrice($price) { $this->container['price'] = $price; return $this; } /** * Gets categories * * @return string[] */ public function getCategories() { return $this->container['categories']; } /** * Sets categories * * @param string[] $categories Category ID-s of the product * * @return $this */ public function setCategories($categories) { $this->container['categories'] = $categories; return $this; } /** * Gets parentId * * @return string */ public function getParentId() { return $this->container['parentId']; } /** * Sets parentId * * @param string $parentId Parent product id of the product * * @return $this */ public function setParentId($parentId) { $this->container['parentId'] = $parentId; return $this; } /** * Gets metaInfo * * @return map[string,string] */ public function getMetaInfo() { return $this->container['metaInfo']; } /** * Sets metaInfo * * @param map[string,string] $metaInfo Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. * * @return $this */ public function setMetaInfo($metaInfo) { $this->container['metaInfo'] = $metaInfo; return $this; } /** * Gets updateEnabled * * @return bool */ public function getUpdateEnabled() { return $this->container['updateEnabled']; } /** * Sets updateEnabled * * @param bool $updateEnabled Facilitate to update the existing category in the same request (updateEnabled = true) * * @return $this */ public function setUpdateEnabled($updateEnabled) { $this->container['updateEnabled'] = $updateEnabled; return $this; } /** * Gets deletedAt * * @return string */ public function getDeletedAt() { return $this->container['deletedAt']; } /** * Sets deletedAt * * @param string $deletedAt UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database * * @return $this */ public function setDeletedAt($deletedAt) { $this->container['deletedAt'] = $deletedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetProducts.php 0000644 00000017512 15021222673 0013236 0 ustar 00 <?php /** * GetProducts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetProducts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProducts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getProducts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'products' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'products' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'products' => 'products', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'products' => 'setProducts', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'products' => 'getProducts', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['products'] = isset($data['products']) ? $data['products'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['products'] === null) { $invalidProperties[] = "'products' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets products * * @return object[] */ public function getProducts() { return $this->container['products']; } /** * Sets products * * @param object[] $products products * * @return $this */ public function setProducts($products) { $this->container['products'] = $products; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of products * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body8.php 0000644 00000026371 15021222673 0011763 0 ustar 00 <?php /** * Body8 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body8 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body8 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_8'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'visitorId' => 'string', 'text' => 'string', 'agentId' => 'string', 'receivedFrom' => 'string', 'agentEmail' => 'string', 'agentName' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'visitorId' => null, 'text' => null, 'agentId' => null, 'receivedFrom' => null, 'agentEmail' => 'email', 'agentName' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'visitorId' => 'visitorId', 'text' => 'text', 'agentId' => 'agentId', 'receivedFrom' => 'receivedFrom', 'agentEmail' => 'agentEmail', 'agentName' => 'agentName' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'visitorId' => 'setVisitorId', 'text' => 'setText', 'agentId' => 'setAgentId', 'receivedFrom' => 'setReceivedFrom', 'agentEmail' => 'setAgentEmail', 'agentName' => 'setAgentName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'visitorId' => 'getVisitorId', 'text' => 'getText', 'agentId' => 'getAgentId', 'receivedFrom' => 'getReceivedFrom', 'agentEmail' => 'getAgentEmail', 'agentName' => 'getAgentName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['visitorId'] = isset($data['visitorId']) ? $data['visitorId'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['agentId'] = isset($data['agentId']) ? $data['agentId'] : null; $this->container['receivedFrom'] = isset($data['receivedFrom']) ? $data['receivedFrom'] : null; $this->container['agentEmail'] = isset($data['agentEmail']) ? $data['agentEmail'] : null; $this->container['agentName'] = isset($data['agentName']) ? $data['agentName'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['visitorId'] === null) { $invalidProperties[] = "'visitorId' can't be null"; } if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets visitorId * * @return string */ public function getVisitorId() { return $this->container['visitorId']; } /** * Sets visitorId * * @param string $visitorId visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> * * @return $this */ public function setVisitorId($visitorId) { $this->container['visitorId'] = $visitorId; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text message text * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Gets agentId * * @return string */ public function getAgentId() { return $this->container['agentId']; } /** * Sets agentId * * @param string $agentId agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). * * @return $this */ public function setAgentId($agentId) { $this->container['agentId'] = $agentId; return $this; } /** * Gets receivedFrom * * @return string */ public function getReceivedFrom() { return $this->container['receivedFrom']; } /** * Sets receivedFrom * * @param string $receivedFrom mark your messages to distinguish messages created by you from the others. * * @return $this */ public function setReceivedFrom($receivedFrom) { $this->container['receivedFrom'] = $receivedFrom; return $this; } /** * Gets agentEmail * * @return string */ public function getAgentEmail() { return $this->container['agentEmail']; } /** * Sets agentEmail * * @param string $agentEmail agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. * * @return $this */ public function setAgentEmail($agentEmail) { $this->container['agentEmail'] = $agentEmail; return $this; } /** * Gets agentName * * @return string */ public function getAgentName() { return $this->container['agentName']; } /** * Sets agentName * * @param string $agentName agent name * * @return $this */ public function setAgentName($agentName) { $this->container['agentName'] = $agentName; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactCampaignStatsUnsubscriptions.php 0000644 00000022035 15021222673 0020634 0 ustar 00 <?php /** * GetContactCampaignStatsUnsubscriptions * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactCampaignStatsUnsubscriptions Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsUnsubscriptions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactCampaignStats_unsubscriptions'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'userUnsubscription' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]', 'adminUnsubscription' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'userUnsubscription' => null, 'adminUnsubscription' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'userUnsubscription' => 'userUnsubscription', 'adminUnsubscription' => 'adminUnsubscription' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'userUnsubscription' => 'setUserUnsubscription', 'adminUnsubscription' => 'setAdminUnsubscription' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'userUnsubscription' => 'getUserUnsubscription', 'adminUnsubscription' => 'getAdminUnsubscription' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['userUnsubscription'] = isset($data['userUnsubscription']) ? $data['userUnsubscription'] : null; $this->container['adminUnsubscription'] = isset($data['adminUnsubscription']) ? $data['adminUnsubscription'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['userUnsubscription'] === null) { $invalidProperties[] = "'userUnsubscription' can't be null"; } if ($this->container['adminUnsubscription'] === null) { $invalidProperties[] = "'adminUnsubscription' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets userUnsubscription * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[] */ public function getUserUnsubscription() { return $this->container['userUnsubscription']; } /** * Sets userUnsubscription * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[] $userUnsubscription Contact has unsubscribed via the unsubscription link in the email * * @return $this */ public function setUserUnsubscription($userUnsubscription) { $this->container['userUnsubscription'] = $userUnsubscription; return $this; } /** * Gets adminUnsubscription * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[] */ public function getAdminUnsubscription() { return $this->container['adminUnsubscription']; } /** * Sets adminUnsubscription * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[] $adminUnsubscription Contact has been unsubscribed from the administrator * * @return $this */ public function setAdminUnsubscription($adminUnsubscription) { $this->container['adminUnsubscription'] = $adminUnsubscription; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInvitedUsersList.php 0000644 00000016135 15021222673 0014713 0 ustar 00 <?php /** * GetInvitedUsersList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInvitedUsersList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInvitedUsersList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'users' => '\Brevo\Client\Model\GetInvitedUsersListUsers[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'users' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'users' => 'users' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'users' => 'setUsers' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'users' => 'getUsers' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['users'] = isset($data['users']) ? $data['users'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets users * * @return \Brevo\Client\Model\GetInvitedUsersListUsers[] */ public function getUsers() { return $this->container['users']; } /** * Sets users * * @param \Brevo\Client\Model\GetInvitedUsersListUsers[] $users Get invited users list * * @return $this */ public function setUsers($users) { $this->container['users'] = $users; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateEmailCampaignSender.php 0000644 00000021152 15021222673 0015761 0 ustar 00 <?php /** * UpdateEmailCampaignSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateEmailCampaignSender Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaignSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateEmailCampaign_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Sender Name from which the campaign emails are sent * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Sender email from which the campaign emails are sent * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateCategory.php 0000644 00000023460 15021222673 0015036 0 ustar 00 <?php /** * CreateUpdateCategory * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateCategory Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateCategory implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateCategory'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'updateEnabled' => 'bool', 'deletedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'email', 'name' => null, 'url' => null, 'updateEnabled' => null, 'deletedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'updateEnabled' => 'updateEnabled', 'deletedAt' => 'deletedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'updateEnabled' => 'setUpdateEnabled', 'deletedAt' => 'setDeletedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'updateEnabled' => 'getUpdateEnabled', 'deletedAt' => 'getDeletedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : false; $this->container['deletedAt'] = isset($data['deletedAt']) ? $data['deletedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique Category ID as saved in the shop * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name **Mandatory in case of creation**. Name of the Category, as displayed in the shop * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the category * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets updateEnabled * * @return bool */ public function getUpdateEnabled() { return $this->container['updateEnabled']; } /** * Sets updateEnabled * * @param bool $updateEnabled Facilitate to update the existing category in the same request (updateEnabled = true) * * @return $this */ public function setUpdateEnabled($updateEnabled) { $this->container['updateEnabled'] = $updateEnabled; return $this; } /** * Gets deletedAt * * @return string */ public function getDeletedAt() { return $this->container['deletedAt']; } /** * Sets deletedAt * * @param string $deletedAt UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database * * @return $this */ public function setDeletedAt($deletedAt) { $this->container['deletedAt'] = $deletedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacBlockedContactsContacts.php 0000644 00000023375 15021222673 0017514 0 ustar 00 <?php /** * GetTransacBlockedContactsContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacBlockedContactsContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContactsContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacBlockedContacts_contacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'senderEmail' => 'string', 'reason' => '\Brevo\Client\Model\GetTransacBlockedContactsReason', 'blockedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'senderEmail' => 'email', 'reason' => null, 'blockedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'senderEmail' => 'senderEmail', 'reason' => 'reason', 'blockedAt' => 'blockedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'senderEmail' => 'setSenderEmail', 'reason' => 'setReason', 'blockedAt' => 'setBlockedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'senderEmail' => 'getSenderEmail', 'reason' => 'getReason', 'blockedAt' => 'getBlockedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['senderEmail'] = isset($data['senderEmail']) ? $data['senderEmail'] : null; $this->container['reason'] = isset($data['reason']) ? $data['reason'] : null; $this->container['blockedAt'] = isset($data['blockedAt']) ? $data['blockedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['senderEmail'] === null) { $invalidProperties[] = "'senderEmail' can't be null"; } if ($this->container['reason'] === null) { $invalidProperties[] = "'reason' can't be null"; } if ($this->container['blockedAt'] === null) { $invalidProperties[] = "'blockedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the blocked or unsubscribed contact * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets senderEmail * * @return string */ public function getSenderEmail() { return $this->container['senderEmail']; } /** * Sets senderEmail * * @param string $senderEmail Sender email address of the blocked or unsubscribed contact * * @return $this */ public function setSenderEmail($senderEmail) { $this->container['senderEmail'] = $senderEmail; return $this; } /** * Gets reason * * @return \Brevo\Client\Model\GetTransacBlockedContactsReason */ public function getReason() { return $this->container['reason']; } /** * Sets reason * * @param \Brevo\Client\Model\GetTransacBlockedContactsReason $reason reason * * @return $this */ public function setReason($reason) { $this->container['reason'] = $reason; return $this; } /** * Gets blockedAt * * @return string */ public function getBlockedAt() { return $this->container['blockedAt']; } /** * Sets blockedAt * * @param string $blockedAt Date when the contact was blocked or unsubscribed on * * @return $this */ public function setBlockedAt($blockedAt) { $this->container['blockedAt'] = $blockedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccount.php 0000644 00000021706 15021222673 0013027 0 ustar 00 <?php /** * GetAccount * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \Brevo\Client\ObjectSerializer; /** * GetAccount Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccount extends GetExtendedClient { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccount'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'plan' => '\Brevo\Client\Model\GetAccountPlan[]', 'relay' => '\Brevo\Client\Model\GetAccountRelay', 'marketingAutomation' => '\Brevo\Client\Model\GetAccountMarketingAutomation' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'plan' => null, 'relay' => null, 'marketingAutomation' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes + parent::swaggerTypes(); } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats + parent::swaggerFormats(); } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'plan' => 'plan', 'relay' => 'relay', 'marketingAutomation' => 'marketingAutomation' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'plan' => 'setPlan', 'relay' => 'setRelay', 'marketingAutomation' => 'setMarketingAutomation' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'plan' => 'getPlan', 'relay' => 'getRelay', 'marketingAutomation' => 'getMarketingAutomation' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return parent::attributeMap() + self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return parent::setters() + self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return parent::getters() + self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { parent::__construct($data); $this->container['plan'] = isset($data['plan']) ? $data['plan'] : null; $this->container['relay'] = isset($data['relay']) ? $data['relay'] : null; $this->container['marketingAutomation'] = isset($data['marketingAutomation']) ? $data['marketingAutomation'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = parent::listInvalidProperties(); if ($this->container['plan'] === null) { $invalidProperties[] = "'plan' can't be null"; } if ($this->container['relay'] === null) { $invalidProperties[] = "'relay' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets plan * * @return \Brevo\Client\Model\GetAccountPlan[] */ public function getPlan() { return $this->container['plan']; } /** * Sets plan * * @param \Brevo\Client\Model\GetAccountPlan[] $plan Information about your plans and credits * * @return $this */ public function setPlan($plan) { $this->container['plan'] = $plan; return $this; } /** * Gets relay * * @return \Brevo\Client\Model\GetAccountRelay */ public function getRelay() { return $this->container['relay']; } /** * Sets relay * * @param \Brevo\Client\Model\GetAccountRelay $relay relay * * @return $this */ public function setRelay($relay) { $this->container['relay'] = $relay; return $this; } /** * Gets marketingAutomation * * @return \Brevo\Client\Model\GetAccountMarketingAutomation */ public function getMarketingAutomation() { return $this->container['marketingAutomation']; } /** * Sets marketingAutomation * * @param \Brevo\Client\Model\GetAccountMarketingAutomation $marketingAutomation marketingAutomation * * @return $this */ public function setMarketingAutomation($marketingAutomation) { $this->container['marketingAutomation'] = $marketingAutomation; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacEmailsList.php 0000644 00000020111 15021222673 0015002 0 ustar 00 <?php /** * GetTransacEmailsList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacEmailsList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailsList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacEmailsList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'transactionalEmails' => '\Brevo\Client\Model\GetTransacEmailsListTransactionalEmails[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => 'int64', 'transactionalEmails' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'transactionalEmails' => 'transactionalEmails' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'transactionalEmails' => 'setTransactionalEmails' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'transactionalEmails' => 'getTransactionalEmails' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['transactionalEmails'] = isset($data['transactionalEmails']) ? $data['transactionalEmails'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Total number of transactional emails available on your account according to the passed filter * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets transactionalEmails * * @return \Brevo\Client\Model\GetTransacEmailsListTransactionalEmails[] */ public function getTransactionalEmails() { return $this->container['transactionalEmails']; } /** * Sets transactionalEmails * * @param \Brevo\Client\Model\GetTransacEmailsListTransactionalEmails[] $transactionalEmails transactionalEmails * * @return $this */ public function setTransactionalEmails($transactionalEmails) { $this->container['transactionalEmails'] = $transactionalEmails; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfoApiKeysV2.php 0000644 00000017410 15021222673 0014765 0 ustar 00 <?php /** * GetChildInfoApiKeysV2 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildInfoApiKeysV2 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeysV2 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo_apiKeys_v2'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'key' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'key' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'key' => 'key' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'key' => 'setKey' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'key' => 'getKey' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['key'] = isset($data['key']) ? $data['key'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['key'] === null) { $invalidProperties[] = "'key' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the key for version 2 * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets key * * @return string */ public function getKey() { return $this->container['key']; } /** * Sets key * * @param string $key API Key for version 2 * * @return $this */ public function setKey($key) { $this->container['key'] = $key; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedClient.php 0000644 00000016365 15021222673 0014337 0 ustar 00 <?php /** * GetExtendedClient * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \Brevo\Client\ObjectSerializer; /** * GetExtendedClient Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedClient extends GetClient { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedClient'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'address' => '\Brevo\Client\Model\GetExtendedClientAddress' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'address' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes + parent::swaggerTypes(); } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats + parent::swaggerFormats(); } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'address' => 'address' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'address' => 'setAddress' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'address' => 'getAddress' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return parent::attributeMap() + self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return parent::setters() + self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return parent::getters() + self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { parent::__construct($data); $this->container['address'] = isset($data['address']) ? $data['address'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = parent::listInvalidProperties(); if ($this->container['address'] === null) { $invalidProperties[] = "'address' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets address * * @return \Brevo\Client\Model\GetExtendedClientAddress */ public function getAddress() { return $this->container['address']; } /** * Sets address * * @param \Brevo\Client\Model\GetExtendedClientAddress $address address * * @return $this */ public function setAddress($address) { $this->container['address'] = $address; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/PipelineStage.php 0000644 00000016747 15021222673 0013535 0 ustar 00 <?php /** * PipelineStage * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * PipelineStage Class Doc Comment * * @category Class * @description List of stages * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PipelineStage implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'PipelineStage'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Stage id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Stage name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountUpdatePlanRequestFeatures.php 0000644 00000020574 15021222673 0020071 0 ustar 00 <?php /** * SubAccountUpdatePlanRequestFeatures * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountUpdatePlanRequestFeatures Class Doc Comment * * @category Class * @description Features details to update * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequestFeatures implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountUpdatePlanRequest_features'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'users' => 'int', 'landingPage' => 'int', 'inbox' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'users' => 'int64', 'landingPage' => 'int64', 'inbox' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'users' => 'users', 'landingPage' => 'landingPage', 'inbox' => 'inbox' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'users' => 'setUsers', 'landingPage' => 'setLandingPage', 'inbox' => 'setInbox' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'users' => 'getUsers', 'landingPage' => 'getLandingPage', 'inbox' => 'getInbox' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['users'] = isset($data['users']) ? $data['users'] : null; $this->container['landingPage'] = isset($data['landingPage']) ? $data['landingPage'] : null; $this->container['inbox'] = isset($data['inbox']) ? $data['inbox'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets users * * @return int */ public function getUsers() { return $this->container['users']; } /** * Sets users * * @param int $users Number of multi-users * * @return $this */ public function setUsers($users) { $this->container['users'] = $users; return $this; } /** * Gets landingPage * * @return int */ public function getLandingPage() { return $this->container['landingPage']; } /** * Sets landingPage * * @param int $landingPage Number of landing pages * * @return $this */ public function setLandingPage($landingPage) { $this->container['landingPage'] = $landingPage; return $this; } /** * Gets inbox * * @return int */ public function getInbox() { return $this->container['inbox']; } /** * Sets inbox * * @param int $inbox Number of inboxes * * @return $this */ public function setInbox($inbox) { $this->container['inbox'] = $inbox; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSegments.php 0000644 00000017313 15021222673 0013217 0 ustar 00 <?php /** * GetSegments * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSegments Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSegments implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSegments'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'segments' => '\Brevo\Client\Model\GetSegmentsSegments', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'segments' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'segments' => 'segments', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'segments' => 'setSegments', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'segments' => 'getSegments', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['segments'] = isset($data['segments']) ? $data['segments'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets segments * * @return \Brevo\Client\Model\GetSegmentsSegments */ public function getSegments() { return $this->container['segments']; } /** * Sets segments * * @param \Brevo\Client\Model\GetSegmentsSegments $segments segments * * @return $this */ public function setSegments($segments) { $this->container['segments'] = $segments; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of Segments available in your account * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetEmailEventReport.php 0000644 00000016144 15021222673 0014660 0 ustar 00 <?php /** * GetEmailEventReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetEmailEventReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailEventReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getEmailEventReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'events' => '\Brevo\Client\Model\GetEmailEventReportEvents[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'events' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'events' => 'events' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'events' => 'setEvents' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'events' => 'getEvents' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['events'] = isset($data['events']) ? $data['events'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets events * * @return \Brevo\Client\Model\GetEmailEventReportEvents[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param \Brevo\Client\Model\GetEmailEventReportEvents[] $events events * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedCampaignStatsGlobalStats.php 0000644 00000015046 15021222673 0020012 0 ustar 00 <?php /** * GetExtendedCampaignStatsGlobalStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedCampaignStatsGlobalStats Class Doc Comment * * @category Class * @description Overall statistics of the campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignStatsGlobalStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedCampaignStats_globalStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ConversationsMessageFileImageInfo.php 0000644 00000022327 15021222673 0017514 0 ustar 00 <?php /** * ConversationsMessageFileImageInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ConversationsMessageFileImageInfo Class Doc Comment * * @category Class * @description image info is passed in case the file is an image * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessageFileImageInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'ConversationsMessage_file_imageInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'width' => 'int', 'height' => 'int', 'previewUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'width' => 'int64', 'height' => 'int64', 'previewUrl' => 'url' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'width' => 'width', 'height' => 'height', 'previewUrl' => 'previewUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'width' => 'setWidth', 'height' => 'setHeight', 'previewUrl' => 'setPreviewUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'width' => 'getWidth', 'height' => 'getHeight', 'previewUrl' => 'getPreviewUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['width'] = isset($data['width']) ? $data['width'] : null; $this->container['height'] = isset($data['height']) ? $data['height'] : null; $this->container['previewUrl'] = isset($data['previewUrl']) ? $data['previewUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if (!is_null($this->container['width']) && ($this->container['width'] < 0)) { $invalidProperties[] = "invalid value for 'width', must be bigger than or equal to 0."; } if (!is_null($this->container['height']) && ($this->container['height'] < 0)) { $invalidProperties[] = "invalid value for 'height', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets width * * @return int */ public function getWidth() { return $this->container['width']; } /** * Sets width * * @param int $width Width of the image * * @return $this */ public function setWidth($width) { if (!is_null($width) && ($width < 0)) { throw new \InvalidArgumentException('invalid value for $width when calling ConversationsMessageFileImageInfo., must be bigger than or equal to 0.'); } $this->container['width'] = $width; return $this; } /** * Gets height * * @return int */ public function getHeight() { return $this->container['height']; } /** * Sets height * * @param int $height height of the image * * @return $this */ public function setHeight($height) { if (!is_null($height) && ($height < 0)) { throw new \InvalidArgumentException('invalid value for $height when calling ConversationsMessageFileImageInfo., must be bigger than or equal to 0.'); } $this->container['height'] = $height; return $this; } /** * Gets previewUrl * * @return string */ public function getPreviewUrl() { return $this->container['previewUrl']; } /** * Sets previewUrl * * @param string $previewUrl URL of the preview * * @return $this */ public function setPreviewUrl($previewUrl) { $this->container['previewUrl'] = $previewUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacAggregatedSmsReport.php 0000644 00000032320 15021222673 0016652 0 ustar 00 <?php /** * GetTransacAggregatedSmsReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacAggregatedSmsReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacAggregatedSmsReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacAggregatedSmsReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'range' => 'string', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', 'softBounces' => 'int', 'blocked' => 'int', 'unsubscribed' => 'int', 'replied' => 'int', 'accepted' => 'int', 'rejected' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'range' => null, 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', 'softBounces' => 'int64', 'blocked' => 'int64', 'unsubscribed' => 'int64', 'replied' => 'int64', 'accepted' => 'int64', 'rejected' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'range' => 'range', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'blocked' => 'blocked', 'unsubscribed' => 'unsubscribed', 'replied' => 'replied', 'accepted' => 'accepted', 'rejected' => 'rejected' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'range' => 'setRange', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'blocked' => 'setBlocked', 'unsubscribed' => 'setUnsubscribed', 'replied' => 'setReplied', 'accepted' => 'setAccepted', 'rejected' => 'setRejected' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'range' => 'getRange', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'blocked' => 'getBlocked', 'unsubscribed' => 'getUnsubscribed', 'replied' => 'getReplied', 'accepted' => 'getAccepted', 'rejected' => 'getRejected' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['range'] = isset($data['range']) ? $data['range'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['blocked'] = isset($data['blocked']) ? $data['blocked'] : null; $this->container['unsubscribed'] = isset($data['unsubscribed']) ? $data['unsubscribed'] : null; $this->container['replied'] = isset($data['replied']) ? $data['replied'] : null; $this->container['accepted'] = isset($data['accepted']) ? $data['accepted'] : null; $this->container['rejected'] = isset($data['rejected']) ? $data['rejected'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets range * * @return string */ public function getRange() { return $this->container['range']; } /** * Sets range * * @param string $range Time frame of the report * * @return $this */ public function setRange($range) { $this->container['range'] = $range; return $this; } /** * Gets requests * * @return int */ public function getRequests() { return $this->container['requests']; } /** * Sets requests * * @param int $requests Number of requests for the timeframe * * @return $this */ public function setRequests($requests) { $this->container['requests'] = $requests; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered SMS for the timeframe * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of hardbounces for the timeframe * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounces for the timeframe * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets blocked * * @return int */ public function getBlocked() { return $this->container['blocked']; } /** * Sets blocked * * @param int $blocked Number of blocked contact for the timeframe * * @return $this */ public function setBlocked($blocked) { $this->container['blocked'] = $blocked; return $this; } /** * Gets unsubscribed * * @return int */ public function getUnsubscribed() { return $this->container['unsubscribed']; } /** * Sets unsubscribed * * @param int $unsubscribed Number of unsubscription for the timeframe * * @return $this */ public function setUnsubscribed($unsubscribed) { $this->container['unsubscribed'] = $unsubscribed; return $this; } /** * Gets replied * * @return int */ public function getReplied() { return $this->container['replied']; } /** * Sets replied * * @param int $replied Number of answered SMS for the timeframe * * @return $this */ public function setReplied($replied) { $this->container['replied'] = $replied; return $this; } /** * Gets accepted * * @return int */ public function getAccepted() { return $this->container['accepted']; } /** * Sets accepted * * @param int $accepted Number of accepted for the timeframe * * @return $this */ public function setAccepted($accepted) { $this->container['accepted'] = $accepted; return $this; } /** * Gets rejected * * @return int */ public function getRejected() { return $this->container['rejected']; } /** * Sets rejected * * @param int $rejected Number of rejected for the timeframe * * @return $this */ public function setRejected($rejected) { $this->container['rejected'] = $rejected; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateDomainModelDnsRecords.php 0000644 00000020073 15021222673 0016272 0 ustar 00 <?php /** * CreateDomainModelDnsRecords * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateDomainModelDnsRecords Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModelDnsRecords implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createDomainModel_dns_records'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'dkimRecord' => '\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord', 'brevoCode' => '\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'dkimRecord' => null, 'brevoCode' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'dkimRecord' => 'dkim_record', 'brevoCode' => 'brevo_code' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'dkimRecord' => 'setDkimRecord', 'brevoCode' => 'setBrevoCode' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'dkimRecord' => 'getDkimRecord', 'brevoCode' => 'getBrevoCode' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['dkimRecord'] = isset($data['dkimRecord']) ? $data['dkimRecord'] : null; $this->container['brevoCode'] = isset($data['brevoCode']) ? $data['brevoCode'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets dkimRecord * * @return \Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord */ public function getDkimRecord() { return $this->container['dkimRecord']; } /** * Sets dkimRecord * * @param \Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord $dkimRecord dkimRecord * * @return $this */ public function setDkimRecord($dkimRecord) { $this->container['dkimRecord'] = $dkimRecord; return $this; } /** * Gets brevoCode * * @return \Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord */ public function getBrevoCode() { return $this->container['brevoCode']; } /** * Sets brevoCode * * @param \Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord $brevoCode brevoCode * * @return $this */ public function setBrevoCode($brevoCode) { $this->container['brevoCode'] = $brevoCode; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RemainingCreditModelChild.php 0000644 00000017607 15021222673 0015771 0 ustar 00 <?php /** * RemainingCreditModelChild * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RemainingCreditModelChild Class Doc Comment * * @category Class * @description Credits remaining for child account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModelChild implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'remainingCreditModel_child'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sms' => 'double', 'email' => 'double' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sms' => 'double', 'email' => 'double' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sms' => 'sms', 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sms' => 'setSms', 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sms' => 'getSms', 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sms'] === null) { $invalidProperties[] = "'sms' can't be null"; } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sms * * @return double */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param double $sms SMS Credits remaining for child account * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets email * * @return double */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param double $email Email Credits remaining for child account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetEmailEventReportEvents.php 0000644 00000037423 15021222673 0016050 0 ustar 00 <?php /** * GetEmailEventReportEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetEmailEventReportEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailEventReportEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getEmailEventReport_events'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'date' => 'string', 'subject' => 'string', 'messageId' => 'string', 'event' => 'string', 'reason' => 'string', 'tag' => 'string', 'ip' => 'string', 'link' => 'string', 'from' => 'string', 'templateId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'date' => null, 'subject' => null, 'messageId' => null, 'event' => null, 'reason' => null, 'tag' => null, 'ip' => null, 'link' => null, 'from' => 'email', 'templateId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'date' => 'date', 'subject' => 'subject', 'messageId' => 'messageId', 'event' => 'event', 'reason' => 'reason', 'tag' => 'tag', 'ip' => 'ip', 'link' => 'link', 'from' => 'from', 'templateId' => 'templateId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'date' => 'setDate', 'subject' => 'setSubject', 'messageId' => 'setMessageId', 'event' => 'setEvent', 'reason' => 'setReason', 'tag' => 'setTag', 'ip' => 'setIp', 'link' => 'setLink', 'from' => 'setFrom', 'templateId' => 'setTemplateId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'date' => 'getDate', 'subject' => 'getSubject', 'messageId' => 'getMessageId', 'event' => 'getEvent', 'reason' => 'getReason', 'tag' => 'getTag', 'ip' => 'getIp', 'link' => 'getLink', 'from' => 'getFrom', 'templateId' => 'getTemplateId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENT_BOUNCES = 'bounces'; const EVENT_HARD_BOUNCES = 'hardBounces'; const EVENT_SOFT_BOUNCES = 'softBounces'; const EVENT_DELIVERED = 'delivered'; const EVENT_SPAM = 'spam'; const EVENT_REQUESTS = 'requests'; const EVENT_OPENED = 'opened'; const EVENT_CLICKS = 'clicks'; const EVENT_INVALID = 'invalid'; const EVENT_DEFERRED = 'deferred'; const EVENT_BLOCKED = 'blocked'; const EVENT_UNSUBSCRIBED = 'unsubscribed'; const EVENT_ERROR = 'error'; const EVENT_LOADED_BY_PROXY = 'loadedByProxy'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventAllowableValues() { return [ self::EVENT_BOUNCES, self::EVENT_HARD_BOUNCES, self::EVENT_SOFT_BOUNCES, self::EVENT_DELIVERED, self::EVENT_SPAM, self::EVENT_REQUESTS, self::EVENT_OPENED, self::EVENT_CLICKS, self::EVENT_INVALID, self::EVENT_DEFERRED, self::EVENT_BLOCKED, self::EVENT_UNSUBSCRIBED, self::EVENT_ERROR, self::EVENT_LOADED_BY_PROXY, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['event'] = isset($data['event']) ? $data['event'] : null; $this->container['reason'] = isset($data['reason']) ? $data['reason'] : null; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['link'] = isset($data['link']) ? $data['link'] : null; $this->container['from'] = isset($data['from']) ? $data['from'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['messageId'] === null) { $invalidProperties[] = "'messageId' can't be null"; } if ($this->container['event'] === null) { $invalidProperties[] = "'event' can't be null"; } $allowedValues = $this->getEventAllowableValues(); if (!is_null($this->container['event']) && !in_array($this->container['event'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address which generates the event * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date UTC date-time on which the event has been generated * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the event * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message ID which generated the event * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets event * * @return string */ public function getEvent() { return $this->container['event']; } /** * Sets event * * @param string $event Event which occurred * * @return $this */ public function setEvent($event) { $allowedValues = $this->getEventAllowableValues(); if (!in_array($event, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['event'] = $event; return $this; } /** * Gets reason * * @return string */ public function getReason() { return $this->container['reason']; } /** * Sets reason * * @param string $reason Reason of bounce (only available if the event is hardbounce or softbounce) * * @return $this */ public function setReason($reason) { $this->container['reason'] = $reason; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the email which generated the event * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets link * * @return string */ public function getLink() { return $this->container['link']; } /** * Sets link * * @param string $link The link which is sent to the user (only available if the event is requests or opened or clicks) * * @return $this */ public function setLink($link) { $this->container['link'] = $link; return $this; } /** * Gets from * * @return string */ public function getFrom() { return $this->container['from']; } /** * Sets from * * @param string $from Sender email from which the emails are sent * * @return $this */ public function setFrom($from) { $this->container['from'] = $from; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId ID of the template (only available if the email is template based) * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateDomainModel.php 0000644 00000022210 15021222673 0014276 0 ustar 00 <?php /** * CreateDomainModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateDomainModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createDomainModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'domainName' => 'string', 'message' => 'string', 'dnsRecords' => '\Brevo\Client\Model\CreateDomainModelDnsRecords' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'domainName' => null, 'message' => null, 'dnsRecords' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'domainName' => 'domain_name', 'message' => 'message', 'dnsRecords' => 'dns_records' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'domainName' => 'setDomainName', 'message' => 'setMessage', 'dnsRecords' => 'setDnsRecords' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'domainName' => 'getDomainName', 'message' => 'getMessage', 'dnsRecords' => 'getDnsRecords' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['domainName'] = isset($data['domainName']) ? $data['domainName'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; $this->container['dnsRecords'] = isset($data['dnsRecords']) ? $data['dnsRecords'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the Domain created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets domainName * * @return string */ public function getDomainName() { return $this->container['domainName']; } /** * Sets domainName * * @param string $domainName Domain * * @return $this */ public function setDomainName($domainName) { $this->container['domainName'] = $domainName; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Success message * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Gets dnsRecords * * @return \Brevo\Client\Model\CreateDomainModelDnsRecords */ public function getDnsRecords() { return $this->container['dnsRecords']; } /** * Sets dnsRecords * * @param \Brevo\Client\Model\CreateDomainModelDnsRecords $dnsRecords dnsRecords * * @return $this */ public function setDnsRecords($dnsRecords) { $this->container['dnsRecords'] = $dnsRecords; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsEventReport.php 0000644 00000016126 15021222673 0014373 0 ustar 00 <?php /** * GetSmsEventReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsEventReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsEventReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsEventReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'events' => '\Brevo\Client\Model\GetSmsEventReportEvents[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'events' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'events' => 'events' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'events' => 'setEvents' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'events' => 'getEvents' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['events'] = isset($data['events']) ? $data['events'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets events * * @return \Brevo\Client\Model\GetSmsEventReportEvents[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param \Brevo\Client\Model\GetSmsEventReportEvents[] $events events * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSharedTemplateUrl.php 0000644 00000016421 15021222673 0015016 0 ustar 00 <?php /** * GetSharedTemplateUrl * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSharedTemplateUrl Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSharedTemplateUrl implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSharedTemplateUrl'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sharedUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sharedUrl' => 'url' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sharedUrl' => 'sharedUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sharedUrl' => 'setSharedUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sharedUrl' => 'getSharedUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sharedUrl'] = isset($data['sharedUrl']) ? $data['sharedUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sharedUrl'] === null) { $invalidProperties[] = "'sharedUrl' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sharedUrl * * @return string */ public function getSharedUrl() { return $this->container['sharedUrl']; } /** * Sets sharedUrl * * @param string $sharedUrl A unique URL for the email campaign or transactional template. This URL can be shared with other Brevo users. * * @return $this */ public function setSharedUrl($sharedUrl) { $this->container['sharedUrl'] = $sharedUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailBcc.php 0000644 00000017337 15021222673 0014115 0 ustar 00 <?php /** * SendSmtpEmailBcc * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailBcc Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailBcc implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_bcc'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the recipient in bcc * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the recipient in bcc. Maximum allowed characters are 70. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactDetails.php 0000644 00000033561 15021222673 0014336 0 ustar 00 <?php /** * GetContactDetails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactDetails Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactDetails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'id' => 'int', 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'createdAt' => 'string', 'modifiedAt' => 'string', 'listIds' => 'int[]', 'listUnsubscribed' => 'int[]', 'attributes' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'id' => 'int64', 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'createdAt' => null, 'modifiedAt' => null, 'listIds' => 'int64', 'listUnsubscribed' => 'int64', 'attributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'id' => 'id', 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'listIds' => 'listIds', 'listUnsubscribed' => 'listUnsubscribed', 'attributes' => 'attributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'id' => 'setId', 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'listIds' => 'setListIds', 'listUnsubscribed' => 'setListUnsubscribed', 'attributes' => 'setAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'id' => 'getId', 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'listIds' => 'getListIds', 'listUnsubscribed' => 'getListUnsubscribed', 'attributes' => 'getAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['emailBlacklisted'] = isset($data['emailBlacklisted']) ? $data['emailBlacklisted'] : null; $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['listUnsubscribed'] = isset($data['listUnsubscribed']) ? $data['listUnsubscribed'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['emailBlacklisted'] === null) { $invalidProperties[] = "'emailBlacklisted' can't be null"; } if ($this->container['smsBlacklisted'] === null) { $invalidProperties[] = "'smsBlacklisted' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } if ($this->container['listIds'] === null) { $invalidProperties[] = "'listIds' can't be null"; } if ($this->container['attributes'] === null) { $invalidProperties[] = "'attributes' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the contact for which you requested the details * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the contact for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets emailBlacklisted * * @return bool */ public function getEmailBlacklisted() { return $this->container['emailBlacklisted']; } /** * Sets emailBlacklisted * * @param bool $emailBlacklisted Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) * * @return $this */ public function setEmailBlacklisted($emailBlacklisted) { $this->container['emailBlacklisted'] = $emailBlacklisted; return $this; } /** * Gets smsBlacklisted * * @return bool */ public function getSmsBlacklisted() { return $this->container['smsBlacklisted']; } /** * Sets smsBlacklisted * * @param bool $smsBlacklisted Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) * * @return $this */ public function setSmsBlacklisted($smsBlacklisted) { $this->container['smsBlacklisted'] = $smsBlacklisted; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds listIds * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets listUnsubscribed * * @return int[] */ public function getListUnsubscribed() { return $this->container['listUnsubscribed']; } /** * Sets listUnsubscribed * * @param int[] $listUnsubscribed listUnsubscribed * * @return $this */ public function setListUnsubscribed($listUnsubscribed) { $this->container['listUnsubscribed'] = $listUnsubscribed; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Set of attributes of the contact * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactCampaignStatsTransacAttributes.php 0000644 00000021523 15021222673 0021065 0 ustar 00 <?php /** * GetContactCampaignStatsTransacAttributes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactCampaignStatsTransacAttributes Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsTransacAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactCampaignStats_transacAttributes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'orderDate' => '\DateTime', 'orderPrice' => 'float', 'orderId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'orderDate' => 'date', 'orderPrice' => 'float', 'orderId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'orderDate' => 'orderDate', 'orderPrice' => 'orderPrice', 'orderId' => 'orderId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'orderDate' => 'setOrderDate', 'orderPrice' => 'setOrderPrice', 'orderId' => 'setOrderId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'orderDate' => 'getOrderDate', 'orderPrice' => 'getOrderPrice', 'orderId' => 'getOrderId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['orderDate'] = isset($data['orderDate']) ? $data['orderDate'] : null; $this->container['orderPrice'] = isset($data['orderPrice']) ? $data['orderPrice'] : null; $this->container['orderId'] = isset($data['orderId']) ? $data['orderId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['orderDate'] === null) { $invalidProperties[] = "'orderDate' can't be null"; } if ($this->container['orderPrice'] === null) { $invalidProperties[] = "'orderPrice' can't be null"; } if ($this->container['orderId'] === null) { $invalidProperties[] = "'orderId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets orderDate * * @return \DateTime */ public function getOrderDate() { return $this->container['orderDate']; } /** * Sets orderDate * * @param \DateTime $orderDate Date of the order * * @return $this */ public function setOrderDate($orderDate) { $this->container['orderDate'] = $orderDate; return $this; } /** * Gets orderPrice * * @return float */ public function getOrderPrice() { return $this->container['orderPrice']; } /** * Sets orderPrice * * @param float $orderPrice Price of the order * * @return $this */ public function setOrderPrice($orderPrice) { $this->container['orderPrice'] = $orderPrice; return $this; } /** * Gets orderId * * @return int */ public function getOrderId() { return $this->container['orderId']; } /** * Sets orderId * * @param int $orderId ID of the order * * @return $this */ public function setOrderId($orderId) { $this->container['orderId'] = $orderId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsMessagesSent.php 0000644 00000020206 15021222673 0022404 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsMessagesSent * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsMessagesSent Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsMessagesSent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_messagesSent'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'eventTime' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'eventTime' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'eventTime' => 'eventTime' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'eventTime' => 'setEventTime' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'eventTime' => 'getEventTime' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreatedBatchId.php 0000644 00000016163 15021222673 0013562 0 ustar 00 <?php /** * CreatedBatchId * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreatedBatchId Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreatedBatchId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createdBatchId'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'batchId' => 'float' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'batchId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'batchId' => 'batchId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'batchId' => 'setBatchId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'batchId' => 'getBatchId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['batchId'] === null) { $invalidProperties[] = "'batchId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets batchId * * @return float */ public function getBatchId() { return $this->container['batchId']; } /** * Sets batchId * * @param float $batchId Batch ID of the request * * @return $this */ public function setBatchId($batchId) { $this->container['batchId'] = $batchId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.php 0000644 00000022204 15021222673 0023215 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptions * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsUnsubscriptions Class Doc Comment * * @category Class * @description Listing of the unsubscription for the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_unsubscriptions'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'userUnsubscription' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[]', 'adminUnsubscription' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'userUnsubscription' => null, 'adminUnsubscription' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'userUnsubscription' => 'userUnsubscription', 'adminUnsubscription' => 'adminUnsubscription' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'userUnsubscription' => 'setUserUnsubscription', 'adminUnsubscription' => 'setAdminUnsubscription' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'userUnsubscription' => 'getUserUnsubscription', 'adminUnsubscription' => 'getAdminUnsubscription' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['userUnsubscription'] = isset($data['userUnsubscription']) ? $data['userUnsubscription'] : null; $this->container['adminUnsubscription'] = isset($data['adminUnsubscription']) ? $data['adminUnsubscription'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['userUnsubscription'] === null) { $invalidProperties[] = "'userUnsubscription' can't be null"; } if ($this->container['adminUnsubscription'] === null) { $invalidProperties[] = "'adminUnsubscription' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets userUnsubscription * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[] */ public function getUserUnsubscription() { return $this->container['userUnsubscription']; } /** * Sets userUnsubscription * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription[] $userUnsubscription Contact unsubscribe via unsubscription link in a campaign * * @return $this */ public function setUserUnsubscription($userUnsubscription) { $this->container['userUnsubscription'] = $userUnsubscription; return $this; } /** * Gets adminUnsubscription * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[] */ public function getAdminUnsubscription() { return $this->container['adminUnsubscription']; } /** * Sets adminUnsubscription * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription[] $adminUnsubscription Contact has been unsubscribed from the administrator * * @return $this */ public function setAdminUnsubscription($adminUnsubscription) { $this->container['adminUnsubscription'] = $adminUnsubscription; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateContact.php 0000644 00000030465 15021222673 0013533 0 ustar 00 <?php /** * UpdateContact * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateContact Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateContact implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateContact'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'attributes' => 'object', 'extId' => 'string', 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'listIds' => 'int[]', 'unlinkListIds' => 'int[]', 'smtpBlacklistSender' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'attributes' => null, 'extId' => null, 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'listIds' => 'int64', 'unlinkListIds' => 'int64', 'smtpBlacklistSender' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'attributes' => 'attributes', 'extId' => 'ext_id', 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'listIds' => 'listIds', 'unlinkListIds' => 'unlinkListIds', 'smtpBlacklistSender' => 'smtpBlacklistSender' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'attributes' => 'setAttributes', 'extId' => 'setExtId', 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'listIds' => 'setListIds', 'unlinkListIds' => 'setUnlinkListIds', 'smtpBlacklistSender' => 'setSmtpBlacklistSender' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'attributes' => 'getAttributes', 'extId' => 'getExtId', 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'listIds' => 'getListIds', 'unlinkListIds' => 'getUnlinkListIds', 'smtpBlacklistSender' => 'getSmtpBlacklistSender' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['extId'] = isset($data['extId']) ? $data['extId'] : null; $this->container['emailBlacklisted'] = isset($data['emailBlacklisted']) ? $data['emailBlacklisted'] : null; $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['unlinkListIds'] = isset($data['unlinkListIds']) ? $data['unlinkListIds'] : null; $this->container['smtpBlacklistSender'] = isset($data['smtpBlacklistSender']) ? $data['smtpBlacklistSender'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets extId * * @return string */ public function getExtId() { return $this->container['extId']; } /** * Sets extId * * @param string $extId Pass your own Id to update ext_id of a contact. * * @return $this */ public function setExtId($extId) { $this->container['extId'] = $extId; return $this; } /** * Gets emailBlacklisted * * @return bool */ public function getEmailBlacklisted() { return $this->container['emailBlacklisted']; } /** * Sets emailBlacklisted * * @param bool $emailBlacklisted Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) * * @return $this */ public function setEmailBlacklisted($emailBlacklisted) { $this->container['emailBlacklisted'] = $emailBlacklisted; return $this; } /** * Gets smsBlacklisted * * @return bool */ public function getSmsBlacklisted() { return $this->container['smsBlacklisted']; } /** * Sets smsBlacklisted * * @param bool $smsBlacklisted Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) * * @return $this */ public function setSmsBlacklisted($smsBlacklisted) { $this->container['smsBlacklisted'] = $smsBlacklisted; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Ids of the lists to add the contact to * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets unlinkListIds * * @return int[] */ public function getUnlinkListIds() { return $this->container['unlinkListIds']; } /** * Sets unlinkListIds * * @param int[] $unlinkListIds Ids of the lists to remove the contact from * * @return $this */ public function setUnlinkListIds($unlinkListIds) { $this->container['unlinkListIds'] = $unlinkListIds; return $this; } /** * Gets smtpBlacklistSender * * @return string[] */ public function getSmtpBlacklistSender() { return $this->container['smtpBlacklistSender']; } /** * Sets smtpBlacklistSender * * @param string[] $smtpBlacklistSender transactional email forbidden sender for contact. Use only for email Contact * * @return $this */ public function setSmtpBlacklistSender($smtpBlacklistSender) { $this->container['smtpBlacklistSender'] = $smtpBlacklistSender; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body9.php 0000644 00000016015 15021222673 0011756 0 ustar 00 <?php /** * Body9 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body9 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body9 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_9'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'text' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'text' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'text' => 'text' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'text' => 'setText' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'text' => 'getText' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['text'] = isset($data['text']) ? $data['text'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text edited message text * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendTransacSms.php 0000644 00000034354 15021222673 0013666 0 ustar 00 <?php /** * SendTransacSms * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendTransacSms Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTransacSms implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendTransacSms'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sender' => 'string', 'recipient' => 'string', 'content' => 'string', 'type' => 'string', 'tag' => 'string', 'webUrl' => 'string', 'unicodeEnabled' => 'bool', 'organisationPrefix' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sender' => null, 'recipient' => null, 'content' => null, 'type' => null, 'tag' => null, 'webUrl' => 'url', 'unicodeEnabled' => null, 'organisationPrefix' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sender' => 'sender', 'recipient' => 'recipient', 'content' => 'content', 'type' => 'type', 'tag' => 'tag', 'webUrl' => 'webUrl', 'unicodeEnabled' => 'unicodeEnabled', 'organisationPrefix' => 'organisationPrefix' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sender' => 'setSender', 'recipient' => 'setRecipient', 'content' => 'setContent', 'type' => 'setType', 'tag' => 'setTag', 'webUrl' => 'setWebUrl', 'unicodeEnabled' => 'setUnicodeEnabled', 'organisationPrefix' => 'setOrganisationPrefix' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sender' => 'getSender', 'recipient' => 'getRecipient', 'content' => 'getContent', 'type' => 'getType', 'tag' => 'getTag', 'webUrl' => 'getWebUrl', 'unicodeEnabled' => 'getUnicodeEnabled', 'organisationPrefix' => 'getOrganisationPrefix' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_TRANSACTIONAL = 'transactional'; const TYPE_MARKETING = 'marketing'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_TRANSACTIONAL, self::TYPE_MARKETING, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['recipient'] = isset($data['recipient']) ? $data['recipient'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : 'transactional'; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['webUrl'] = isset($data['webUrl']) ? $data['webUrl'] : null; $this->container['unicodeEnabled'] = isset($data['unicodeEnabled']) ? $data['unicodeEnabled'] : false; $this->container['organisationPrefix'] = isset($data['organisationPrefix']) ? $data['organisationPrefix'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ((mb_strlen($this->container['sender']) > 15)) { $invalidProperties[] = "invalid value for 'sender', the character length must be smaller than or equal to 15."; } if ($this->container['recipient'] === null) { $invalidProperties[] = "'recipient' can't be null"; } if ($this->container['content'] === null) { $invalidProperties[] = "'content' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** * * @return $this */ public function setSender($sender) { if ((mb_strlen($sender) > 15)) { throw new \InvalidArgumentException('invalid length for $sender when calling SendTransacSms., must be smaller than or equal to 15.'); } $this->container['sender'] = $sender; return $this; } /** * Gets recipient * * @return string */ public function getRecipient() { return $this->container['recipient']; } /** * Sets recipient * * @param string $recipient Mobile number to send SMS with the country code * * @return $this */ public function setRecipient($recipient) { $this->container['recipient'] = $recipient; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Content of the message. If more than 160 characters long, will be sent as multiple text messages * * @return $this */ public function setContent($content) { $this->container['content'] = $content; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the message * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets webUrl * * @return string */ public function getWebUrl() { return $this->container['webUrl']; } /** * Sets webUrl * * @param string $webUrl Webhook to call for each event triggered by the message (delivered etc.) * * @return $this */ public function setWebUrl($webUrl) { $this->container['webUrl'] = $webUrl; return $this; } /** * Gets unicodeEnabled * * @return bool */ public function getUnicodeEnabled() { return $this->container['unicodeEnabled']; } /** * Sets unicodeEnabled * * @param bool $unicodeEnabled Format of the message. It indicates whether the content should be treated as unicode or not. * * @return $this */ public function setUnicodeEnabled($unicodeEnabled) { $this->container['unicodeEnabled'] = $unicodeEnabled; return $this; } /** * Gets organisationPrefix * * @return string */ public function getOrganisationPrefix() { return $this->container['organisationPrefix']; } /** * Sets organisationPrefix * * @param string $organisationPrefix A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** * * @return $this */ public function setOrganisationPrefix($organisationPrefix) { $this->container['organisationPrefix'] = $organisationPrefix; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildDomains.php 0000644 00000014667 15021222673 0014001 0 ustar 00 <?php /** * GetChildDomains * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildDomains Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildDomains implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildDomains'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWATemplates.php 0000644 00000017757 15021222673 0013634 0 ustar 00 <?php /** * GetWATemplates * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWATemplates Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWATemplates implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWATemplates'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'templates' => '\Brevo\Client\Model\GetWATemplatesTemplates[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'templates' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'templates' => 'templates', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'templates' => 'setTemplates', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'templates' => 'getTemplates', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['templates'] = isset($data['templates']) ? $data['templates'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['templates'] === null) { $invalidProperties[] = "'templates' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets templates * * @return \Brevo\Client\Model\GetWATemplatesTemplates[] */ public function getTemplates() { return $this->container['templates']; } /** * Sets templates * * @param \Brevo\Client\Model\GetWATemplatesTemplates[] $templates templates * * @return $this */ public function setTemplates($templates) { $this->container['templates'] = $templates; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of whatsApp templates retrived * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateCouponCollection.php 0000644 00000016500 15021222673 0015411 0 ustar 00 <?php /** * UpdateCouponCollection * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateCouponCollection Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateCouponCollection implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateCouponCollection'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'defaultCoupon' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'defaultCoupon' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'defaultCoupon' => 'defaultCoupon' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'defaultCoupon' => 'setDefaultCoupon' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'defaultCoupon' => 'getDefaultCoupon' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['defaultCoupon'] = isset($data['defaultCoupon']) ? $data['defaultCoupon'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['defaultCoupon'] === null) { $invalidProperties[] = "'defaultCoupon' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets defaultCoupon * * @return string */ public function getDefaultCoupon() { return $this->container['defaultCoupon']; } /** * Sets defaultCoupon * * @param string $defaultCoupon A default coupon to be used in case there are no coupons left * * @return $this */ public function setDefaultCoupon($defaultCoupon) { $this->container['defaultCoupon'] = $defaultCoupon; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateAttributeEnumeration.php 0000644 00000017503 15021222673 0016271 0 ustar 00 <?php /** * CreateAttributeEnumeration * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateAttributeEnumeration Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateAttributeEnumeration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createAttribute_enumeration'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'int', 'label' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => null, 'label' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'label' => 'label' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'label' => 'setLabel' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'label' => 'getLabel' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['label'] = isset($data['label']) ? $data['label'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } if ($this->container['label'] === null) { $invalidProperties[] = "'label' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return int */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param int $value Id of the value * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets label * * @return string */ public function getLabel() { return $this->container['label']; } /** * Sets label * * @param string $label Label of the value * * @return $this */ public function setLabel($label) { $this->container['label'] = $label; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse2012.php 0000644 00000016050 15021222673 0014231 0 ustar 00 <?php /** * InlineResponse2012 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse2012 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2012 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_201_2'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id The id of the created collection * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailAttachment.php 0000644 00000021732 15021222673 0015510 0 ustar 00 <?php /** * SendSmtpEmailAttachment * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailAttachment Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailAttachment implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_attachment'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string', 'content' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => 'url', 'content' => 'byte', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url', 'content' => 'content', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl', 'content' => 'setContent', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl', 'content' => 'getContent', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if (!is_null($this->container['content']) && !preg_match("/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/", $this->container['content'])) { $invalidProperties[] = "invalid value for 'content', must be conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url Absolute url of the attachment (no local file). * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Base64 encoded chunk data of the attachment generated on the fly * * @return $this */ public function setContent($content) { if (!is_null($content) && (!preg_match("/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/", $content))) { throw new \InvalidArgumentException("invalid value for $content when calling SendSmtpEmailAttachment., must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."); } $this->container['content'] = $content; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Required if content is passed. Name of the attachment * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UploadImageToGallery.php 0000644 00000017555 15021222673 0015014 0 ustar 00 <?php /** * UploadImageToGallery * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UploadImageToGallery Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UploadImageToGallery implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'uploadImageToGallery'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'imageUrl' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'imageUrl' => null, 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'imageUrl' => 'imageUrl', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'imageUrl' => 'setImageUrl', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'imageUrl' => 'getImageUrl', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['imageUrl'] = isset($data['imageUrl']) ? $data['imageUrl'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['imageUrl'] === null) { $invalidProperties[] = "'imageUrl' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets imageUrl * * @return string */ public function getImageUrl() { return $this->container['imageUrl']; } /** * Sets imageUrl * * @param string $imageUrl The absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are - jpeg, jpg, png, bmp, gif. * * @return $this */ public function setImageUrl($imageUrl) { $this->container['imageUrl'] = $imageUrl; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the image. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCampaignStats.php 0000644 00000047012 15021222673 0014167 0 ustar 00 <?php /** * GetCampaignStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCampaignStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCampaignStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'listId' => 'int', 'uniqueClicks' => 'int', 'clickers' => 'int', 'complaints' => 'int', 'delivered' => 'int', 'sent' => 'int', 'softBounces' => 'int', 'hardBounces' => 'int', 'uniqueViews' => 'int', 'trackableViews' => 'int', 'trackableViewsRate' => 'float', 'estimatedViews' => 'int', 'unsubscriptions' => 'int', 'viewed' => 'int', 'deferred' => 'int', 'returnBounce' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'listId' => 'int64', 'uniqueClicks' => 'int64', 'clickers' => 'int64', 'complaints' => 'int64', 'delivered' => 'int64', 'sent' => 'int64', 'softBounces' => 'int64', 'hardBounces' => 'int64', 'uniqueViews' => 'int64', 'trackableViews' => 'int64', 'trackableViewsRate' => 'float', 'estimatedViews' => 'int64', 'unsubscriptions' => 'int64', 'viewed' => 'int64', 'deferred' => 'int64', 'returnBounce' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'listId' => 'listId', 'uniqueClicks' => 'uniqueClicks', 'clickers' => 'clickers', 'complaints' => 'complaints', 'delivered' => 'delivered', 'sent' => 'sent', 'softBounces' => 'softBounces', 'hardBounces' => 'hardBounces', 'uniqueViews' => 'uniqueViews', 'trackableViews' => 'trackableViews', 'trackableViewsRate' => 'trackableViewsRate', 'estimatedViews' => 'estimatedViews', 'unsubscriptions' => 'unsubscriptions', 'viewed' => 'viewed', 'deferred' => 'deferred', 'returnBounce' => 'returnBounce' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'listId' => 'setListId', 'uniqueClicks' => 'setUniqueClicks', 'clickers' => 'setClickers', 'complaints' => 'setComplaints', 'delivered' => 'setDelivered', 'sent' => 'setSent', 'softBounces' => 'setSoftBounces', 'hardBounces' => 'setHardBounces', 'uniqueViews' => 'setUniqueViews', 'trackableViews' => 'setTrackableViews', 'trackableViewsRate' => 'setTrackableViewsRate', 'estimatedViews' => 'setEstimatedViews', 'unsubscriptions' => 'setUnsubscriptions', 'viewed' => 'setViewed', 'deferred' => 'setDeferred', 'returnBounce' => 'setReturnBounce' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'listId' => 'getListId', 'uniqueClicks' => 'getUniqueClicks', 'clickers' => 'getClickers', 'complaints' => 'getComplaints', 'delivered' => 'getDelivered', 'sent' => 'getSent', 'softBounces' => 'getSoftBounces', 'hardBounces' => 'getHardBounces', 'uniqueViews' => 'getUniqueViews', 'trackableViews' => 'getTrackableViews', 'trackableViewsRate' => 'getTrackableViewsRate', 'estimatedViews' => 'getEstimatedViews', 'unsubscriptions' => 'getUnsubscriptions', 'viewed' => 'getViewed', 'deferred' => 'getDeferred', 'returnBounce' => 'getReturnBounce' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['listId'] = isset($data['listId']) ? $data['listId'] : null; $this->container['uniqueClicks'] = isset($data['uniqueClicks']) ? $data['uniqueClicks'] : null; $this->container['clickers'] = isset($data['clickers']) ? $data['clickers'] : null; $this->container['complaints'] = isset($data['complaints']) ? $data['complaints'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['sent'] = isset($data['sent']) ? $data['sent'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['uniqueViews'] = isset($data['uniqueViews']) ? $data['uniqueViews'] : null; $this->container['trackableViews'] = isset($data['trackableViews']) ? $data['trackableViews'] : null; $this->container['trackableViewsRate'] = isset($data['trackableViewsRate']) ? $data['trackableViewsRate'] : null; $this->container['estimatedViews'] = isset($data['estimatedViews']) ? $data['estimatedViews'] : null; $this->container['unsubscriptions'] = isset($data['unsubscriptions']) ? $data['unsubscriptions'] : null; $this->container['viewed'] = isset($data['viewed']) ? $data['viewed'] : null; $this->container['deferred'] = isset($data['deferred']) ? $data['deferred'] : null; $this->container['returnBounce'] = isset($data['returnBounce']) ? $data['returnBounce'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['uniqueClicks'] === null) { $invalidProperties[] = "'uniqueClicks' can't be null"; } if ($this->container['clickers'] === null) { $invalidProperties[] = "'clickers' can't be null"; } if ($this->container['complaints'] === null) { $invalidProperties[] = "'complaints' can't be null"; } if ($this->container['delivered'] === null) { $invalidProperties[] = "'delivered' can't be null"; } if ($this->container['sent'] === null) { $invalidProperties[] = "'sent' can't be null"; } if ($this->container['softBounces'] === null) { $invalidProperties[] = "'softBounces' can't be null"; } if ($this->container['hardBounces'] === null) { $invalidProperties[] = "'hardBounces' can't be null"; } if ($this->container['uniqueViews'] === null) { $invalidProperties[] = "'uniqueViews' can't be null"; } if ($this->container['trackableViews'] === null) { $invalidProperties[] = "'trackableViews' can't be null"; } if ($this->container['unsubscriptions'] === null) { $invalidProperties[] = "'unsubscriptions' can't be null"; } if ($this->container['viewed'] === null) { $invalidProperties[] = "'viewed' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets listId * * @return int */ public function getListId() { return $this->container['listId']; } /** * Sets listId * * @param int $listId List Id of email campaign (only in case of get email campaign(s)(not for global stats)) * * @return $this */ public function setListId($listId) { $this->container['listId'] = $listId; return $this; } /** * Gets uniqueClicks * * @return int */ public function getUniqueClicks() { return $this->container['uniqueClicks']; } /** * Sets uniqueClicks * * @param int $uniqueClicks Number of unique clicks for the campaign * * @return $this */ public function setUniqueClicks($uniqueClicks) { $this->container['uniqueClicks'] = $uniqueClicks; return $this; } /** * Gets clickers * * @return int */ public function getClickers() { return $this->container['clickers']; } /** * Sets clickers * * @param int $clickers Number of total clicks for the campaign * * @return $this */ public function setClickers($clickers) { $this->container['clickers'] = $clickers; return $this; } /** * Gets complaints * * @return int */ public function getComplaints() { return $this->container['complaints']; } /** * Sets complaints * * @param int $complaints Number of complaints (Spam reports) for the campaign * * @return $this */ public function setComplaints($complaints) { $this->container['complaints'] = $complaints; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered emails for the campaign * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets sent * * @return int */ public function getSent() { return $this->container['sent']; } /** * Sets sent * * @param int $sent Number of sent emails for the campaign * * @return $this */ public function setSent($sent) { $this->container['sent'] = $sent; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounce for the campaign * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of harbounce for the campaign * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets uniqueViews * * @return int */ public function getUniqueViews() { return $this->container['uniqueViews']; } /** * Sets uniqueViews * * @param int $uniqueViews Number of unique openings for the campaign * * @return $this */ public function setUniqueViews($uniqueViews) { $this->container['uniqueViews'] = $uniqueViews; return $this; } /** * Gets trackableViews * * @return int */ public function getTrackableViews() { return $this->container['trackableViews']; } /** * Sets trackableViews * * @param int $trackableViews Recipients without any privacy protection option enabled in their email client * * @return $this */ public function setTrackableViews($trackableViews) { $this->container['trackableViews'] = $trackableViews; return $this; } /** * Gets trackableViewsRate * * @return float */ public function getTrackableViewsRate() { return $this->container['trackableViewsRate']; } /** * Sets trackableViewsRate * * @param float $trackableViewsRate Rate of recipients without any privacy protection option enabled in their email client * * @return $this */ public function setTrackableViewsRate($trackableViewsRate) { $this->container['trackableViewsRate'] = $trackableViewsRate; return $this; } /** * Gets estimatedViews * * @return int */ public function getEstimatedViews() { return $this->container['estimatedViews']; } /** * Sets estimatedViews * * @param int $estimatedViews Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails * * @return $this */ public function setEstimatedViews($estimatedViews) { $this->container['estimatedViews'] = $estimatedViews; return $this; } /** * Gets unsubscriptions * * @return int */ public function getUnsubscriptions() { return $this->container['unsubscriptions']; } /** * Sets unsubscriptions * * @param int $unsubscriptions Number of unsubscription for the campaign * * @return $this */ public function setUnsubscriptions($unsubscriptions) { $this->container['unsubscriptions'] = $unsubscriptions; return $this; } /** * Gets viewed * * @return int */ public function getViewed() { return $this->container['viewed']; } /** * Sets viewed * * @param int $viewed Number of openings for the campaign * * @return $this */ public function setViewed($viewed) { $this->container['viewed'] = $viewed; return $this; } /** * Gets deferred * * @return int */ public function getDeferred() { return $this->container['deferred']; } /** * Sets deferred * * @param int $deferred Number of deferred emails for the campaign * * @return $this */ public function setDeferred($deferred) { $this->container['deferred'] = $deferred; return $this; } /** * Gets returnBounce * * @return int */ public function getReturnBounce() { return $this->container['returnBounce']; } /** * Sets returnBounce * * @param int $returnBounce Total number of non-delivered campaigns for a particular campaign id. * * @return $this */ public function setReturnBounce($returnBounce) { $this->container['returnBounce'] = $returnBounce; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetails.php 0000644 00000035544 15021222673 0016022 0 ustar 00 <?php /** * GetExtendedContactDetails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetails Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'id' => 'int', 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'createdAt' => 'string', 'modifiedAt' => 'string', 'listIds' => 'int[]', 'listUnsubscribed' => 'int[]', 'attributes' => 'object', 'statistics' => '\Brevo\Client\Model\GetExtendedContactDetailsStatistics' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'id' => 'int64', 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'createdAt' => null, 'modifiedAt' => null, 'listIds' => 'int64', 'listUnsubscribed' => 'int64', 'attributes' => null, 'statistics' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'id' => 'id', 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'listIds' => 'listIds', 'listUnsubscribed' => 'listUnsubscribed', 'attributes' => 'attributes', 'statistics' => 'statistics' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'id' => 'setId', 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'listIds' => 'setListIds', 'listUnsubscribed' => 'setListUnsubscribed', 'attributes' => 'setAttributes', 'statistics' => 'setStatistics' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'id' => 'getId', 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'listIds' => 'getListIds', 'listUnsubscribed' => 'getListUnsubscribed', 'attributes' => 'getAttributes', 'statistics' => 'getStatistics' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['emailBlacklisted'] = isset($data['emailBlacklisted']) ? $data['emailBlacklisted'] : null; $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['listUnsubscribed'] = isset($data['listUnsubscribed']) ? $data['listUnsubscribed'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['statistics'] = isset($data['statistics']) ? $data['statistics'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['emailBlacklisted'] === null) { $invalidProperties[] = "'emailBlacklisted' can't be null"; } if ($this->container['smsBlacklisted'] === null) { $invalidProperties[] = "'smsBlacklisted' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } if ($this->container['listIds'] === null) { $invalidProperties[] = "'listIds' can't be null"; } if ($this->container['attributes'] === null) { $invalidProperties[] = "'attributes' can't be null"; } if ($this->container['statistics'] === null) { $invalidProperties[] = "'statistics' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the contact for which you requested the details * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the contact for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets emailBlacklisted * * @return bool */ public function getEmailBlacklisted() { return $this->container['emailBlacklisted']; } /** * Sets emailBlacklisted * * @param bool $emailBlacklisted Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) * * @return $this */ public function setEmailBlacklisted($emailBlacklisted) { $this->container['emailBlacklisted'] = $emailBlacklisted; return $this; } /** * Gets smsBlacklisted * * @return bool */ public function getSmsBlacklisted() { return $this->container['smsBlacklisted']; } /** * Sets smsBlacklisted * * @param bool $smsBlacklisted Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) * * @return $this */ public function setSmsBlacklisted($smsBlacklisted) { $this->container['smsBlacklisted'] = $smsBlacklisted; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds listIds * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets listUnsubscribed * * @return int[] */ public function getListUnsubscribed() { return $this->container['listUnsubscribed']; } /** * Sets listUnsubscribed * * @param int[] $listUnsubscribed listUnsubscribed * * @return $this */ public function setListUnsubscribed($listUnsubscribed) { $this->container['listUnsubscribed'] = $listUnsubscribed; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Set of attributes of the contact * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets statistics * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatistics */ public function getStatistics() { return $this->container['statistics']; } /** * Sets statistics * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatistics $statistics statistics * * @return $this */ public function setStatistics($statistics) { $this->container['statistics'] = $statistics; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsCampaignRecipients.php 0000644 00000014707 15021222673 0015666 0 ustar 00 <?php /** * GetSmsCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsCampaignRecipients Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsCampaign_recipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RemoveContactFromList.php 0000644 00000021124 15021222673 0015216 0 ustar 00 <?php /** * RemoveContactFromList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RemoveContactFromList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemoveContactFromList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'removeContactFromList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'emails' => 'string[]', 'ids' => 'int[]', 'all' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'emails' => null, 'ids' => 'int64', 'all' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'emails' => 'emails', 'ids' => 'ids', 'all' => 'all' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'emails' => 'setEmails', 'ids' => 'setIds', 'all' => 'setAll' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'emails' => 'getEmails', 'ids' => 'getIds', 'all' => 'getAll' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['emails'] = isset($data['emails']) ? $data['emails'] : null; $this->container['ids'] = isset($data['ids']) ? $data['ids'] : null; $this->container['all'] = isset($data['all']) ? $data['all'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets emails * * @return string[] */ public function getEmails() { return $this->container['emails']; } /** * Sets emails * * @param string[] $emails Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request. * * @return $this */ public function setEmails($emails) { $this->container['emails'] = $emails; return $this; } /** * Gets ids * * @return int[] */ public function getIds() { return $this->container['ids']; } /** * Sets ids * * @param int[] $ids Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. * * @return $this */ public function setIds($ids) { $this->container['ids'] = $ids; return $this; } /** * Gets all * * @return bool */ public function getAll() { return $this->container['all']; } /** * Sets all * * @param bool $all Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress * * @return $this */ public function setAll($all) { $this->container['all'] = $all; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Pipeline.php 0000644 00000020672 15021222673 0012541 0 ustar 00 <?php /** * Pipeline * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Pipeline Class Doc Comment * * @category Class * @description List of stages * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Pipeline implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Pipeline'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'pipeline' => 'string', 'pipelineName' => 'string', 'stages' => '\Brevo\Client\Model\PipelineStage[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'pipeline' => null, 'pipelineName' => null, 'stages' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'pipeline' => 'pipeline', 'pipelineName' => 'pipeline_name', 'stages' => 'stages' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'pipeline' => 'setPipeline', 'pipelineName' => 'setPipelineName', 'stages' => 'setStages' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'pipeline' => 'getPipeline', 'pipelineName' => 'getPipelineName', 'stages' => 'getStages' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['pipeline'] = isset($data['pipeline']) ? $data['pipeline'] : null; $this->container['pipelineName'] = isset($data['pipelineName']) ? $data['pipelineName'] : null; $this->container['stages'] = isset($data['stages']) ? $data['stages'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets pipeline * * @return string */ public function getPipeline() { return $this->container['pipeline']; } /** * Sets pipeline * * @param string $pipeline Pipeline id * * @return $this */ public function setPipeline($pipeline) { $this->container['pipeline'] = $pipeline; return $this; } /** * Gets pipelineName * * @return string */ public function getPipelineName() { return $this->container['pipelineName']; } /** * Sets pipelineName * * @param string $pipelineName Pipeline Name * * @return $this */ public function setPipelineName($pipelineName) { $this->container['pipelineName'] = $pipelineName; return $this; } /** * Gets stages * * @return \Brevo\Client\Model\PipelineStage[] */ public function getStages() { return $this->container['stages']; } /** * Sets stages * * @param \Brevo\Client\Model\PipelineStage[] $stages List of stages * * @return $this */ public function setStages($stages) { $this->container['stages'] = $stages; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateWebhook.php 0000644 00000032212 15021222673 0013507 0 ustar 00 <?php /** * CreateWebhook * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateWebhook Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWebhook implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createWebhook'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string', 'description' => 'string', 'events' => 'string[]', 'type' => 'string', 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => 'url', 'description' => null, 'events' => null, 'type' => null, 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url', 'description' => 'description', 'events' => 'events', 'type' => 'type', 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl', 'description' => 'setDescription', 'events' => 'setEvents', 'type' => 'setType', 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl', 'description' => 'getDescription', 'events' => 'getEvents', 'type' => 'getType', 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENTS_SENT = 'sent'; const EVENTS_HARD_BOUNCE = 'hardBounce'; const EVENTS_SOFT_BOUNCE = 'softBounce'; const EVENTS_BLOCKED = 'blocked'; const EVENTS_SPAM = 'spam'; const EVENTS_DELIVERED = 'delivered'; const EVENTS_REQUEST = 'request'; const EVENTS_CLICK = 'click'; const EVENTS_INVALID = 'invalid'; const EVENTS_DEFERRED = 'deferred'; const EVENTS_OPENED = 'opened'; const EVENTS_UNIQUE_OPENED = 'uniqueOpened'; const EVENTS_UNSUBSCRIBED = 'unsubscribed'; const EVENTS_LIST_ADDITION = 'listAddition'; const EVENTS_CONTACT_UPDATED = 'contactUpdated'; const EVENTS_CONTACT_DELETED = 'contactDeleted'; const EVENTS_INBOUND_EMAIL_PROCESSED = 'inboundEmailProcessed'; const TYPE_TRANSACTIONAL = 'transactional'; const TYPE_MARKETING = 'marketing'; const TYPE_INBOUND = 'inbound'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventsAllowableValues() { return [ self::EVENTS_SENT, self::EVENTS_HARD_BOUNCE, self::EVENTS_SOFT_BOUNCE, self::EVENTS_BLOCKED, self::EVENTS_SPAM, self::EVENTS_DELIVERED, self::EVENTS_REQUEST, self::EVENTS_CLICK, self::EVENTS_INVALID, self::EVENTS_DEFERRED, self::EVENTS_OPENED, self::EVENTS_UNIQUE_OPENED, self::EVENTS_UNSUBSCRIBED, self::EVENTS_LIST_ADDITION, self::EVENTS_CONTACT_UPDATED, self::EVENTS_CONTACT_DELETED, self::EVENTS_INBOUND_EMAIL_PROCESSED, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_TRANSACTIONAL, self::TYPE_MARKETING, self::TYPE_INBOUND, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['description'] = isset($data['description']) ? $data['description'] : null; $this->container['events'] = isset($data['events']) ? $data['events'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : 'transactional'; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } if ($this->container['events'] === null) { $invalidProperties[] = "'events' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the webhook * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets description * * @return string */ public function getDescription() { return $this->container['description']; } /** * Sets description * * @param string $description Description of the webhook * * @return $this */ public function setDescription($description) { $this->container['description'] = $description; return $this; } /** * Gets events * * @return string[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param string[] $events - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` * * @return $this */ public function setEvents($events) { $allowedValues = $this->getEventsAllowableValues(); if (array_diff($events, $allowedValues)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'events', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['events'] = $events; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of the webhook * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Inbound domain of webhook, required in case of event type `inbound` * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body3.php 0000644 00000017676 15021222673 0011766 0 ustar 00 <?php /** * Body3 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body3 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body3 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_3'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'attributes' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'attributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'attributes' => 'attributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'attributes' => 'setAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'attributes' => 'getAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of deal * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Attributes for deal creation If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountActivity.php 0000644 00000016077 15021222673 0014551 0 ustar 00 <?php /** * GetAccountActivity * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountActivity Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountActivity implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccountActivity'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'logs' => '\Brevo\Client\Model\GetAccountActivityLogs[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'logs' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'logs' => 'logs' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'logs' => 'setLogs' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'logs' => 'getLogs' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['logs'] = isset($data['logs']) ? $data['logs'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets logs * * @return \Brevo\Client\Model\GetAccountActivityLogs[] */ public function getLogs() { return $this->container['logs']; } /** * Sets logs * * @param \Brevo\Client\Model\GetAccountActivityLogs[] $logs Get user activity logs * * @return $this */ public function setLogs($logs) { $this->container['logs'] = $logs; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailTo1.php 0000644 00000017326 15021222673 0014067 0 ustar 00 <?php /** * SendSmtpEmailTo1 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailTo1 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailTo1 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_to_1'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the recipient * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the recipient. **Maximum allowed characters are 70**. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body11.php 0000644 00000016021 15021222673 0012024 0 ustar 00 <?php /** * Body11 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body11 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body11 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_11'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'text' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'text' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'text' => 'text' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'text' => 'setText' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'text' => 'getText' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['text'] = isset($data['text']) ? $data['text'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text edited message text * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildrenList.php 0000644 00000017205 15021222673 0014016 0 ustar 00 <?php /** * GetChildrenList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildrenList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildrenList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildrenList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'children' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'children' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'children' => 'children', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'children' => 'setChildren', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'children' => 'getChildren', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['children'] = isset($data['children']) ? $data['children'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets children * * @return object[] */ public function getChildren() { return $this->container['children']; } /** * Sets children * * @param object[] $children Your children's account information * * @return $this */ public function setChildren($children) { $this->container['children'] = $children; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of child accounts * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestSmsRecipientExport.php 0000644 00000023216 15021222673 0016151 0 ustar 00 <?php /** * RequestSmsRecipientExport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestSmsRecipientExport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestSmsRecipientExport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestSmsRecipientExport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'notifyURL' => 'string', 'recipientsType' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'notifyURL' => 'url', 'recipientsType' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'notifyURL' => 'notifyURL', 'recipientsType' => 'recipientsType' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'notifyURL' => 'setNotifyURL', 'recipientsType' => 'setRecipientsType' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'notifyURL' => 'getNotifyURL', 'recipientsType' => 'getRecipientsType' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const RECIPIENTS_TYPE_ALL = 'all'; const RECIPIENTS_TYPE_DELIVERED = 'delivered'; const RECIPIENTS_TYPE_ANSWERED = 'answered'; const RECIPIENTS_TYPE_SOFT_BOUNCES = 'softBounces'; const RECIPIENTS_TYPE_HARD_BOUNCES = 'hardBounces'; const RECIPIENTS_TYPE_UNSUBSCRIBED = 'unsubscribed'; /** * Gets allowable values of the enum * * @return string[] */ public function getRecipientsTypeAllowableValues() { return [ self::RECIPIENTS_TYPE_ALL, self::RECIPIENTS_TYPE_DELIVERED, self::RECIPIENTS_TYPE_ANSWERED, self::RECIPIENTS_TYPE_SOFT_BOUNCES, self::RECIPIENTS_TYPE_HARD_BOUNCES, self::RECIPIENTS_TYPE_UNSUBSCRIBED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['notifyURL'] = isset($data['notifyURL']) ? $data['notifyURL'] : null; $this->container['recipientsType'] = isset($data['recipientsType']) ? $data['recipientsType'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['recipientsType'] === null) { $invalidProperties[] = "'recipientsType' can't be null"; } $allowedValues = $this->getRecipientsTypeAllowableValues(); if (!is_null($this->container['recipientsType']) && !in_array($this->container['recipientsType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'recipientsType', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets notifyURL * * @return string */ public function getNotifyURL() { return $this->container['notifyURL']; } /** * Sets notifyURL * * @param string $notifyURL URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 * * @return $this */ public function setNotifyURL($notifyURL) { $this->container['notifyURL'] = $notifyURL; return $this; } /** * Gets recipientsType * * @return string */ public function getRecipientsType() { return $this->container['recipientsType']; } /** * Sets recipientsType * * @param string $recipientsType Filter the recipients based on how they interacted with the campaign * * @return $this */ public function setRecipientsType($recipientsType) { $allowedValues = $this->getRecipientsTypeAllowableValues(); if (!in_array($recipientsType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'recipientsType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['recipientsType'] = $recipientsType; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/DeleteHardbounces.php 0000644 00000021303 15021222673 0014344 0 ustar 00 <?php /** * DeleteHardbounces * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * DeleteHardbounces Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DeleteHardbounces implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'deleteHardbounces'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'startDate' => 'string', 'endDate' => 'string', 'contactEmail' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'startDate' => null, 'endDate' => null, 'contactEmail' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'startDate' => 'startDate', 'endDate' => 'endDate', 'contactEmail' => 'contactEmail' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'startDate' => 'setStartDate', 'endDate' => 'setEndDate', 'contactEmail' => 'setContactEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'startDate' => 'getStartDate', 'endDate' => 'getEndDate', 'contactEmail' => 'getContactEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['startDate'] = isset($data['startDate']) ? $data['startDate'] : null; $this->container['endDate'] = isset($data['endDate']) ? $data['endDate'] : null; $this->container['contactEmail'] = isset($data['contactEmail']) ? $data['contactEmail'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets startDate * * @return string */ public function getStartDate() { return $this->container['startDate']; } /** * Sets startDate * * @param string $startDate Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate * * @return $this */ public function setStartDate($startDate) { $this->container['startDate'] = $startDate; return $this; } /** * Gets endDate * * @return string */ public function getEndDate() { return $this->container['endDate']; } /** * Sets endDate * * @param string $endDate Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate * * @return $this */ public function setEndDate($endDate) { $this->container['endDate'] = $endDate; return $this; } /** * Gets contactEmail * * @return string */ public function getContactEmail() { return $this->container['contactEmail']; } /** * Sets contactEmail * * @param string $contactEmail Target a specific email address * * @return $this */ public function setContactEmail($contactEmail) { $this->container['contactEmail'] = $contactEmail; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Task.php 0000644 00000025136 15021222673 0011676 0 ustar 00 <?php /** * Task * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Task Class Doc Comment * * @category Class * @description Task Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Task implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Task'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'taskTypeId' => 'string', 'name' => 'string', 'contactsIds' => 'int[]', 'dealsIds' => 'string[]', 'companiesIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'taskTypeId' => null, 'name' => null, 'contactsIds' => null, 'dealsIds' => null, 'companiesIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'taskTypeId' => 'taskTypeId', 'name' => 'name', 'contactsIds' => 'contactsIds', 'dealsIds' => 'dealsIds', 'companiesIds' => 'companiesIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'taskTypeId' => 'setTaskTypeId', 'name' => 'setName', 'contactsIds' => 'setContactsIds', 'dealsIds' => 'setDealsIds', 'companiesIds' => 'setCompaniesIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'taskTypeId' => 'getTaskTypeId', 'name' => 'getName', 'contactsIds' => 'getContactsIds', 'dealsIds' => 'getDealsIds', 'companiesIds' => 'getCompaniesIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['taskTypeId'] = isset($data['taskTypeId']) ? $data['taskTypeId'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['contactsIds'] = isset($data['contactsIds']) ? $data['contactsIds'] : null; $this->container['dealsIds'] = isset($data['dealsIds']) ? $data['dealsIds'] : null; $this->container['companiesIds'] = isset($data['companiesIds']) ? $data['companiesIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['taskTypeId'] === null) { $invalidProperties[] = "'taskTypeId' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique task id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets taskTypeId * * @return string */ public function getTaskTypeId() { return $this->container['taskTypeId']; } /** * Sets taskTypeId * * @param string $taskTypeId Id for type of task e.g Call / Email / Meeting etc. * * @return $this */ public function setTaskTypeId($taskTypeId) { $this->container['taskTypeId'] = $taskTypeId; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of task * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets contactsIds * * @return int[] */ public function getContactsIds() { return $this->container['contactsIds']; } /** * Sets contactsIds * * @param int[] $contactsIds Contact ids for contacts linked to this task * * @return $this */ public function setContactsIds($contactsIds) { $this->container['contactsIds'] = $contactsIds; return $this; } /** * Gets dealsIds * * @return string[] */ public function getDealsIds() { return $this->container['dealsIds']; } /** * Sets dealsIds * * @param string[] $dealsIds Deal ids for deals a task is linked to * * @return $this */ public function setDealsIds($dealsIds) { $this->container['dealsIds'] = $dealsIds; return $this; } /** * Gets companiesIds * * @return string[] */ public function getCompaniesIds() { return $this->container['companiesIds']; } /** * Sets companiesIds * * @param string[] $companiesIds Companies ids for companies a task is linked to * * @return $this */ public function setCompaniesIds($companiesIds) { $this->container['companiesIds'] = $companiesIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContacts.php 0000644 00000017512 15021222673 0013211 0 ustar 00 <?php /** * GetContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'contacts' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'contacts' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'contacts' => 'contacts', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'contacts' => 'setContacts', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'contacts' => 'getContacts', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['contacts'] = isset($data['contacts']) ? $data['contacts'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['contacts'] === null) { $invalidProperties[] = "'contacts' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets contacts * * @return object[] */ public function getContacts() { return $this->container['contacts']; } /** * Sets contacts * * @param object[] $contacts contacts * * @return $this */ public function setContacts($contacts) { $this->container['contacts'] = $contacts; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of contacts * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactCampaignStatsClicked.php 0000644 00000020174 15021222673 0016762 0 ustar 00 <?php /** * GetContactCampaignStatsClicked * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactCampaignStatsClicked Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsClicked implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactCampaignStats_clicked'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'links' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'links' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'links' => 'links' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'links' => 'setLinks' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'links' => 'getLinks' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['links'] = isset($data['links']) ? $data['links'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['links'] === null) { $invalidProperties[] = "'links' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets links * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[] */ public function getLinks() { return $this->container['links']; } /** * Sets links * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[] $links links * * @return $this */ public function setLinks($links) { $this->container['links'] = $links; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/FileList.php 0000644 00000014671 15021222673 0012511 0 ustar 00 <?php /** * FileList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * FileList Class Doc Comment * * @category Class * @description List of files * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'FileList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/BodyVariablesItems.php 0000644 00000014656 15021222673 0014531 0 ustar 00 <?php /** * BodyVariablesItems * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * BodyVariablesItems Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class BodyVariablesItems implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'bodyVariablesItems'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildDomain.php 0000644 00000017146 15021222673 0013611 0 ustar 00 <?php /** * GetChildDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domain' => 'string', 'active' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domain' => null, 'active' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domain' => 'domain', 'active' => 'active' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domain' => 'setDomain', 'active' => 'setActive' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domain' => 'getDomain', 'active' => 'getActive' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; $this->container['active'] = isset($data['active']) ? $data['active'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Sender domain * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Gets active * * @return bool */ public function getActive() { return $this->container['active']; } /** * Sets active * * @param bool $active indicates whether a domain is verified or not * * @return $this */ public function setActive($active) { $this->container['active'] = $active; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body2.php 0000644 00000023043 15021222673 0011746 0 ustar 00 <?php /** * Body2 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body2 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body2 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_2'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'linkContactIds' => 'int[]', 'unlinkContactIds' => 'int[]', 'linkDealsIds' => 'string[]', 'unlinkDealsIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'linkContactIds' => 'int64', 'unlinkContactIds' => 'int64', 'linkDealsIds' => null, 'unlinkDealsIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'linkContactIds' => 'linkContactIds', 'unlinkContactIds' => 'unlinkContactIds', 'linkDealsIds' => 'linkDealsIds', 'unlinkDealsIds' => 'unlinkDealsIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'linkContactIds' => 'setLinkContactIds', 'unlinkContactIds' => 'setUnlinkContactIds', 'linkDealsIds' => 'setLinkDealsIds', 'unlinkDealsIds' => 'setUnlinkDealsIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'linkContactIds' => 'getLinkContactIds', 'unlinkContactIds' => 'getUnlinkContactIds', 'linkDealsIds' => 'getLinkDealsIds', 'unlinkDealsIds' => 'getUnlinkDealsIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['linkContactIds'] = isset($data['linkContactIds']) ? $data['linkContactIds'] : null; $this->container['unlinkContactIds'] = isset($data['unlinkContactIds']) ? $data['unlinkContactIds'] : null; $this->container['linkDealsIds'] = isset($data['linkDealsIds']) ? $data['linkDealsIds'] : null; $this->container['unlinkDealsIds'] = isset($data['unlinkDealsIds']) ? $data['unlinkDealsIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets linkContactIds * * @return int[] */ public function getLinkContactIds() { return $this->container['linkContactIds']; } /** * Sets linkContactIds * * @param int[] $linkContactIds Contact ids for contacts to be linked with company * * @return $this */ public function setLinkContactIds($linkContactIds) { $this->container['linkContactIds'] = $linkContactIds; return $this; } /** * Gets unlinkContactIds * * @return int[] */ public function getUnlinkContactIds() { return $this->container['unlinkContactIds']; } /** * Sets unlinkContactIds * * @param int[] $unlinkContactIds Contact ids for contacts to be unlinked from company * * @return $this */ public function setUnlinkContactIds($unlinkContactIds) { $this->container['unlinkContactIds'] = $unlinkContactIds; return $this; } /** * Gets linkDealsIds * * @return string[] */ public function getLinkDealsIds() { return $this->container['linkDealsIds']; } /** * Sets linkDealsIds * * @param string[] $linkDealsIds Deals ids for deals to be linked with company * * @return $this */ public function setLinkDealsIds($linkDealsIds) { $this->container['linkDealsIds'] = $linkDealsIds; return $this; } /** * Gets unlinkDealsIds * * @return string[] */ public function getUnlinkDealsIds() { return $this->container['unlinkDealsIds']; } /** * Sets unlinkDealsIds * * @param string[] $unlinkDealsIds Deals ids for deals to be unlinked from company * * @return $this */ public function setUnlinkDealsIds($unlinkDealsIds) { $this->container['unlinkDealsIds'] = $unlinkDealsIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetUserPermissionPrivileges.php 0000644 00000017767 15021222673 0016470 0 ustar 00 <?php /** * GetUserPermissionPrivileges * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetUserPermissionPrivileges Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetUserPermissionPrivileges implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getUserPermission_privileges'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'feature' => 'string', 'permissions' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'feature' => null, 'permissions' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'feature' => 'feature', 'permissions' => 'permissions' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'feature' => 'setFeature', 'permissions' => 'setPermissions' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'feature' => 'getFeature', 'permissions' => 'getPermissions' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['feature'] = isset($data['feature']) ? $data['feature'] : null; $this->container['permissions'] = isset($data['permissions']) ? $data['permissions'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['feature'] === null) { $invalidProperties[] = "'feature' can't be null"; } if ($this->container['permissions'] === null) { $invalidProperties[] = "'permissions' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets feature * * @return string */ public function getFeature() { return $this->container['feature']; } /** * Sets feature * * @param string $feature feature * * @return $this */ public function setFeature($feature) { $this->container['feature'] = $feature; return $this; } /** * Gets permissions * * @return string[] */ public function getPermissions() { return $this->container['permissions']; } /** * Sets permissions * * @param string[] $permissions permissions * * @return $this */ public function setPermissions($permissions) { $this->container['permissions'] = $permissions; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacEmailsListTransactionalEmails.php 0000644 00000030150 15021222673 0020664 0 ustar 00 <?php /** * GetTransacEmailsListTransactionalEmails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacEmailsListTransactionalEmails Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailsListTransactionalEmails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacEmailsList_transactionalEmails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'subject' => 'string', 'templateId' => 'int', 'messageId' => 'string', 'uuid' => 'string', 'date' => 'string', 'from' => 'string', 'tags' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'subject' => null, 'templateId' => 'int64', 'messageId' => null, 'uuid' => null, 'date' => null, 'from' => 'email', 'tags' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'subject' => 'subject', 'templateId' => 'templateId', 'messageId' => 'messageId', 'uuid' => 'uuid', 'date' => 'date', 'from' => 'from', 'tags' => 'tags' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'subject' => 'setSubject', 'templateId' => 'setTemplateId', 'messageId' => 'setMessageId', 'uuid' => 'setUuid', 'date' => 'setDate', 'from' => 'setFrom', 'tags' => 'setTags' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'subject' => 'getSubject', 'templateId' => 'getTemplateId', 'messageId' => 'getMessageId', 'uuid' => 'getUuid', 'date' => 'getDate', 'from' => 'getFrom', 'tags' => 'getTags' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['uuid'] = isset($data['uuid']) ? $data['uuid'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['from'] = isset($data['from']) ? $data['from'] : null; $this->container['tags'] = isset($data['tags']) ? $data['tags'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['subject'] === null) { $invalidProperties[] = "'subject' can't be null"; } if ($this->container['messageId'] === null) { $invalidProperties[] = "'messageId' can't be null"; } if ($this->container['uuid'] === null) { $invalidProperties[] = "'uuid' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address to which transactional email has been sent * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the sent email * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Id of the template * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message Id of the sent email * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets uuid * * @return string */ public function getUuid() { return $this->container['uuid']; } /** * Sets uuid * * @param string $uuid Unique id of the email sent to a particular contact * * @return $this */ public function setUuid($uuid) { $this->container['uuid'] = $uuid; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date Date on which transactional email was sent * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets from * * @return string */ public function getFrom() { return $this->container['from']; } /** * Sets from * * @param string $from Email address of the sender from which the email was sent * * @return $this */ public function setFrom($from) { $this->container['from'] = $from; return $this; } /** * Gets tags * * @return string[] */ public function getTags() { return $this->container['tags']; } /** * Sets tags * * @param string[] $tags Tags used for your email * * @return $this */ public function setTags($tags) { $this->container['tags'] = $tags; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetDeviceBrowserStats.php 0000644 00000023422 15021222673 0015212 0 ustar 00 <?php /** * GetDeviceBrowserStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetDeviceBrowserStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDeviceBrowserStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getDeviceBrowserStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'clickers' => 'int', 'uniqueClicks' => 'int', 'viewed' => 'int', 'uniqueViews' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'clickers' => 'int64', 'uniqueClicks' => 'int64', 'viewed' => 'int64', 'uniqueViews' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'clickers' => 'clickers', 'uniqueClicks' => 'uniqueClicks', 'viewed' => 'viewed', 'uniqueViews' => 'uniqueViews' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'clickers' => 'setClickers', 'uniqueClicks' => 'setUniqueClicks', 'viewed' => 'setViewed', 'uniqueViews' => 'setUniqueViews' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'clickers' => 'getClickers', 'uniqueClicks' => 'getUniqueClicks', 'viewed' => 'getViewed', 'uniqueViews' => 'getUniqueViews' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['clickers'] = isset($data['clickers']) ? $data['clickers'] : null; $this->container['uniqueClicks'] = isset($data['uniqueClicks']) ? $data['uniqueClicks'] : null; $this->container['viewed'] = isset($data['viewed']) ? $data['viewed'] : null; $this->container['uniqueViews'] = isset($data['uniqueViews']) ? $data['uniqueViews'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['clickers'] === null) { $invalidProperties[] = "'clickers' can't be null"; } if ($this->container['uniqueClicks'] === null) { $invalidProperties[] = "'uniqueClicks' can't be null"; } if ($this->container['viewed'] === null) { $invalidProperties[] = "'viewed' can't be null"; } if ($this->container['uniqueViews'] === null) { $invalidProperties[] = "'uniqueViews' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets clickers * * @return int */ public function getClickers() { return $this->container['clickers']; } /** * Sets clickers * * @param int $clickers Number of total clicks for the campaign using the particular browser * * @return $this */ public function setClickers($clickers) { $this->container['clickers'] = $clickers; return $this; } /** * Gets uniqueClicks * * @return int */ public function getUniqueClicks() { return $this->container['uniqueClicks']; } /** * Sets uniqueClicks * * @param int $uniqueClicks Number of unique clicks for the campaign using the particular browser * * @return $this */ public function setUniqueClicks($uniqueClicks) { $this->container['uniqueClicks'] = $uniqueClicks; return $this; } /** * Gets viewed * * @return int */ public function getViewed() { return $this->container['viewed']; } /** * Sets viewed * * @param int $viewed Number of openings for the campaign using the particular browser * * @return $this */ public function setViewed($viewed) { $this->container['viewed'] = $viewed; return $this; } /** * Gets uniqueViews * * @return int */ public function getUniqueViews() { return $this->container['uniqueViews']; } /** * Sets uniqueViews * * @param int $uniqueViews Number of unique openings for the campaign using the particular browser * * @return $this */ public function setUniqueViews($uniqueViews) { $this->container['uniqueViews'] = $uniqueViews; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Order.php 0000644 00000032226 15021222673 0012045 0 ustar 00 <?php /** * Order * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Order Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Order implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'order'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'createdAt' => 'string', 'updatedAt' => 'string', 'status' => 'string', 'amount' => 'float', 'products' => '\Brevo\Client\Model\OrderProducts[]', 'email' => 'string', 'billing' => '\Brevo\Client\Model\OrderBilling', 'coupons' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'createdAt' => null, 'updatedAt' => null, 'status' => null, 'amount' => null, 'products' => null, 'email' => null, 'billing' => null, 'coupons' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'createdAt' => 'createdAt', 'updatedAt' => 'updatedAt', 'status' => 'status', 'amount' => 'amount', 'products' => 'products', 'email' => 'email', 'billing' => 'billing', 'coupons' => 'coupons' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'createdAt' => 'setCreatedAt', 'updatedAt' => 'setUpdatedAt', 'status' => 'setStatus', 'amount' => 'setAmount', 'products' => 'setProducts', 'email' => 'setEmail', 'billing' => 'setBilling', 'coupons' => 'setCoupons' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'createdAt' => 'getCreatedAt', 'updatedAt' => 'getUpdatedAt', 'status' => 'getStatus', 'amount' => 'getAmount', 'products' => 'getProducts', 'email' => 'getEmail', 'billing' => 'getBilling', 'coupons' => 'getCoupons' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['amount'] = isset($data['amount']) ? $data['amount'] : null; $this->container['products'] = isset($data['products']) ? $data['products'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['billing'] = isset($data['billing']) ? $data['billing'] : null; $this->container['coupons'] = isset($data['coupons']) ? $data['coupons'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } if ($this->container['amount'] === null) { $invalidProperties[] = "'amount' can't be null"; } if ($this->container['products'] === null) { $invalidProperties[] = "'products' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique ID of the order. * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created. * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets updatedAt * * @return string */ public function getUpdatedAt() { return $this->container['updatedAt']; } /** * Sets updatedAt * * @param string $updatedAt Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated. * * @return $this */ public function setUpdatedAt($updatedAt) { $this->container['updatedAt'] = $updatedAt; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status State of the order. * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Gets amount * * @return float */ public function getAmount() { return $this->container['amount']; } /** * Sets amount * * @param float $amount Total amount of the order, including all shipping expenses, tax and the price of items. * * @return $this */ public function setAmount($amount) { $this->container['amount'] = $amount; return $this; } /** * Gets products * * @return \Brevo\Client\Model\OrderProducts[] */ public function getProducts() { return $this->container['products']; } /** * Sets products * * @param \Brevo\Client\Model\OrderProducts[] $products products * * @return $this */ public function setProducts($products) { $this->container['products'] = $products; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets billing * * @return \Brevo\Client\Model\OrderBilling */ public function getBilling() { return $this->container['billing']; } /** * Sets billing * * @param \Brevo\Client\Model\OrderBilling $billing billing * * @return $this */ public function setBilling($billing) { $this->container['billing'] = $billing; return $this; } /** * Gets coupons * * @return string[] */ public function getCoupons() { return $this->container['coupons']; } /** * Sets coupons * * @param string[] $coupons Coupons applied to the order. Stored case insensitive. * * @return $this */ public function setCoupons($coupons) { $this->container['coupons'] = $coupons; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreatedProcessId.php 0000644 00000016246 15021222673 0014161 0 ustar 00 <?php /** * CreatedProcessId * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreatedProcessId Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreatedProcessId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createdProcessId'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'processId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'processId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'processId' => 'processId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'processId' => 'setProcessId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'processId' => 'getProcessId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['processId'] = isset($data['processId']) ? $data['processId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['processId'] === null) { $invalidProperties[] = "'processId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets processId * * @return int */ public function getProcessId() { return $this->container['processId']; } /** * Sets processId * * @param int $processId Id of the process created * * @return $this */ public function setProcessId($processId) { $this->container['processId'] = $processId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateCampaignStatus.php 0000644 00000021123 15021222673 0015052 0 ustar 00 <?php /** * UpdateCampaignStatus * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateCampaignStatus Class Doc Comment * * @category Class * @description Status of the campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateCampaignStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateCampaignStatus'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'status' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'status' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'status' => 'status' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'status' => 'setStatus' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'status' => 'getStatus' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_SUSPENDED = 'suspended'; const STATUS_ARCHIVE = 'archive'; const STATUS_DARCHIVE = 'darchive'; const STATUS_SENT = 'sent'; const STATUS_QUEUED = 'queued'; const STATUS_REPLICATE = 'replicate'; const STATUS_REPLICATE_TEMPLATE = 'replicateTemplate'; const STATUS_DRAFT = 'draft'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_SUSPENDED, self::STATUS_ARCHIVE, self::STATUS_DARCHIVE, self::STATUS_SENT, self::STATUS_QUEUED, self::STATUS_REPLICATE, self::STATUS_REPLICATE_TEMPLATE, self::STATUS_DRAFT, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['status'] = isset($data['status']) ? $data['status'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Note:- replicateTemplate status will be available only for template type campaigns. * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!is_null($status) && !in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/OrderBatch.php 0000644 00000017555 15021222673 0013017 0 ustar 00 <?php /** * OrderBatch * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * OrderBatch Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderBatch implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'orderBatch'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'orders' => '\Brevo\Client\Model\Order[]', 'notifyUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'orders' => null, 'notifyUrl' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'orders' => 'orders', 'notifyUrl' => 'notifyUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'orders' => 'setOrders', 'notifyUrl' => 'setNotifyUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'orders' => 'getOrders', 'notifyUrl' => 'getNotifyUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['orders'] = isset($data['orders']) ? $data['orders'] : null; $this->container['notifyUrl'] = isset($data['notifyUrl']) ? $data['notifyUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['orders'] === null) { $invalidProperties[] = "'orders' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets orders * * @return \Brevo\Client\Model\Order[] */ public function getOrders() { return $this->container['orders']; } /** * Sets orders * * @param \Brevo\Client\Model\Order[] $orders array of order objects * * @return $this */ public function setOrders($orders) { $this->container['orders'] = $orders; return $this; } /** * Gets notifyUrl * * @return string */ public function getNotifyUrl() { return $this->container['notifyUrl']; } /** * Sets notifyUrl * * @param string $notifyUrl Notify Url provided by client to get the status of batch request * * @return $this */ public function setNotifyUrl($notifyUrl) { $this->container['notifyUrl'] = $notifyUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Otp.php 0000644 00000015617 15021222673 0011541 0 ustar 00 <?php /** * Otp * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Otp Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Otp implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'otp'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return int */ public function getName() { return $this->container['name']; } /** * Sets name * * @param int $name 6 digit OTP received on email * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/DealsList.php 0000644 00000016016 15021222673 0012655 0 ustar 00 <?php /** * DealsList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * DealsList Class Doc Comment * * @category Class * @description List of Deals * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealsList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'DealsList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'items' => '\Brevo\Client\Model\Deal[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'items' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'items' => 'items' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'items' => 'setItems' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'items' => 'getItems' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['items'] = isset($data['items']) ? $data['items'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets items * * @return \Brevo\Client\Model\Deal[] */ public function getItems() { return $this->container['items']; } /** * Sets items * * @param \Brevo\Client\Model\Deal[] $items List of deals * * @return $this */ public function setItems($items) { $this->container['items'] = $items; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RemoveCredits.php 0000644 00000017174 15021222673 0013552 0 ustar 00 <?php /** * RemoveCredits * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RemoveCredits Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemoveCredits implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'removeCredits'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sms' => 'int', 'email' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sms' => 'int64', 'email' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sms' => 'sms', 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sms' => 'setSms', 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sms' => 'getSms', 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sms * * @return int */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param int $sms Required if email credits are empty. SMS credits to be removed from the child account * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets email * * @return int */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param int $email Required if sms credits are empty. Email credits to be removed from the child account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateDoiContact.php 0000644 00000027242 15021222673 0014147 0 ustar 00 <?php /** * CreateDoiContact * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateDoiContact Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDoiContact implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createDoiContact'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'attributes' => 'object', 'includeListIds' => 'int[]', 'excludeListIds' => 'int[]', 'templateId' => 'int', 'redirectionUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'attributes' => null, 'includeListIds' => 'int64', 'excludeListIds' => 'int64', 'templateId' => 'int64', 'redirectionUrl' => 'url' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'attributes' => 'attributes', 'includeListIds' => 'includeListIds', 'excludeListIds' => 'excludeListIds', 'templateId' => 'templateId', 'redirectionUrl' => 'redirectionUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'attributes' => 'setAttributes', 'includeListIds' => 'setIncludeListIds', 'excludeListIds' => 'setExcludeListIds', 'templateId' => 'setTemplateId', 'redirectionUrl' => 'setRedirectionUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'attributes' => 'getAttributes', 'includeListIds' => 'getIncludeListIds', 'excludeListIds' => 'getExcludeListIds', 'templateId' => 'getTemplateId', 'redirectionUrl' => 'getRedirectionUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['includeListIds'] = isset($data['includeListIds']) ? $data['includeListIds'] : null; $this->container['excludeListIds'] = isset($data['excludeListIds']) ? $data['excludeListIds'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['redirectionUrl'] = isset($data['redirectionUrl']) ? $data['redirectionUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['includeListIds'] === null) { $invalidProperties[] = "'includeListIds' can't be null"; } if ($this->container['templateId'] === null) { $invalidProperties[] = "'templateId' can't be null"; } if ($this->container['redirectionUrl'] === null) { $invalidProperties[] = "'redirectionUrl' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets includeListIds * * @return int[] */ public function getIncludeListIds() { return $this->container['includeListIds']; } /** * Sets includeListIds * * @param int[] $includeListIds Lists under user account where contact should be added * * @return $this */ public function setIncludeListIds($includeListIds) { $this->container['includeListIds'] = $includeListIds; return $this; } /** * Gets excludeListIds * * @return int[] */ public function getExcludeListIds() { return $this->container['excludeListIds']; } /** * Sets excludeListIds * * @param int[] $excludeListIds Lists under user account where contact should not be added * * @return $this */ public function setExcludeListIds($excludeListIds) { $this->container['excludeListIds'] = $excludeListIds; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Id of the Double opt-in (DOI) template * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets redirectionUrl * * @return string */ public function getRedirectionUrl() { return $this->container['redirectionUrl']; } /** * Sets redirectionUrl * * @param string $redirectionUrl URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. * * @return $this */ public function setRedirectionUrl($redirectionUrl) { $this->container['redirectionUrl'] = $redirectionUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateAttribute.php 0000644 00000020054 15021222673 0014074 0 ustar 00 <?php /** * UpdateAttribute * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateAttribute Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateAttribute implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateAttribute'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'string', 'enumeration' => '\Brevo\Client\Model\UpdateAttributeEnumeration[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => null, 'enumeration' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'enumeration' => 'enumeration' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'enumeration' => 'setEnumeration' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'enumeration' => 'getEnumeration' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['enumeration'] = isset($data['enumeration']) ? $data['enumeration'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return string */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param string $value Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets enumeration * * @return \Brevo\Client\Model\UpdateAttributeEnumeration[] */ public function getEnumeration() { return $this->container['enumeration']; } /** * Sets enumeration * * @param \Brevo\Client\Model\UpdateAttributeEnumeration[] $enumeration List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] * * @return $this */ public function setEnumeration($enumeration) { $this->container['enumeration'] = $enumeration; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExternalFeedByUUIDHeaders.php 0000644 00000017124 15021222673 0016256 0 ustar 00 <?php /** * GetExternalFeedByUUIDHeaders * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExternalFeedByUUIDHeaders Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExternalFeedByUUIDHeaders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExternalFeedByUUID_headers'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'value' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'value' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'value' => 'value' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'value' => 'setValue' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'value' => 'getValue' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the header * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets value * * @return string */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param string $value Value of the header * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendReport.php 0000644 00000022125 15021222673 0013054 0 ustar 00 <?php /** * SendReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'language' => 'string', 'email' => '\Brevo\Client\Model\SendReportEmail' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'language' => null, 'email' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'language' => 'language', 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'language' => 'setLanguage', 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'language' => 'getLanguage', 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const LANGUAGE_FR = 'fr'; const LANGUAGE_ES = 'es'; const LANGUAGE_PT = 'pt'; const LANGUAGE_IT = 'it'; const LANGUAGE_DE = 'de'; const LANGUAGE_EN = 'en'; /** * Gets allowable values of the enum * * @return string[] */ public function getLanguageAllowableValues() { return [ self::LANGUAGE_FR, self::LANGUAGE_ES, self::LANGUAGE_PT, self::LANGUAGE_IT, self::LANGUAGE_DE, self::LANGUAGE_EN, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['language'] = isset($data['language']) ? $data['language'] : 'fr'; $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($this->container['language']) && !in_array($this->container['language'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language Language of email content for campaign report sending. * * @return $this */ public function setLanguage($language) { $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($language) && !in_array($language, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['language'] = $language; return $this; } /** * Gets email * * @return \Brevo\Client\Model\SendReportEmail */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param \Brevo\Client\Model\SendReportEmail $email email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateProductModel.php 0000644 00000015670 15021222673 0014523 0 ustar 00 <?php /** * CreateProductModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateProductModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateProductModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createProductModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the Product when a new product is created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetList.php 0000644 00000025072 15021222673 0012346 0 ustar 00 <?php /** * GetList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'totalBlacklisted' => 'int', 'totalSubscribers' => 'int', 'uniqueSubscribers' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'totalBlacklisted' => 'int64', 'totalSubscribers' => 'int64', 'uniqueSubscribers' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'totalBlacklisted' => 'totalBlacklisted', 'totalSubscribers' => 'totalSubscribers', 'uniqueSubscribers' => 'uniqueSubscribers' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'totalBlacklisted' => 'setTotalBlacklisted', 'totalSubscribers' => 'setTotalSubscribers', 'uniqueSubscribers' => 'setUniqueSubscribers' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'totalBlacklisted' => 'getTotalBlacklisted', 'totalSubscribers' => 'getTotalSubscribers', 'uniqueSubscribers' => 'getUniqueSubscribers' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['totalBlacklisted'] = isset($data['totalBlacklisted']) ? $data['totalBlacklisted'] : null; $this->container['totalSubscribers'] = isset($data['totalSubscribers']) ? $data['totalSubscribers'] : null; $this->container['uniqueSubscribers'] = isset($data['uniqueSubscribers']) ? $data['uniqueSubscribers'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['totalBlacklisted'] === null) { $invalidProperties[] = "'totalBlacklisted' can't be null"; } if ($this->container['totalSubscribers'] === null) { $invalidProperties[] = "'totalSubscribers' can't be null"; } if ($this->container['uniqueSubscribers'] === null) { $invalidProperties[] = "'uniqueSubscribers' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the list * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the list * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets totalBlacklisted * * @return int */ public function getTotalBlacklisted() { return $this->container['totalBlacklisted']; } /** * Sets totalBlacklisted * * @param int $totalBlacklisted Number of blacklisted contacts in the list * * @return $this */ public function setTotalBlacklisted($totalBlacklisted) { $this->container['totalBlacklisted'] = $totalBlacklisted; return $this; } /** * Gets totalSubscribers * * @return int */ public function getTotalSubscribers() { return $this->container['totalSubscribers']; } /** * Sets totalSubscribers * * @param int $totalSubscribers Number of contacts in the list * * @return $this */ public function setTotalSubscribers($totalSubscribers) { $this->container['totalSubscribers'] = $totalSubscribers; return $this; } /** * Gets uniqueSubscribers * * @return int */ public function getUniqueSubscribers() { return $this->container['uniqueSubscribers']; } /** * Sets uniqueSubscribers * * @param int $uniqueSubscribers Number of unique contacts in the list * * @return $this */ public function setUniqueSubscribers($uniqueSubscribers) { $this->container['uniqueSubscribers'] = $uniqueSubscribers; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateEmailCampaignRecipients.php 0000644 00000021722 15021222673 0016651 0 ustar 00 <?php /** * UpdateEmailCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateEmailCampaignRecipients Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateEmailCampaign_recipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'exclusionListIds' => 'int[]', 'listIds' => 'int[]', 'segmentIds' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'exclusionListIds' => 'int64', 'listIds' => 'int64', 'segmentIds' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'exclusionListIds' => 'exclusionListIds', 'listIds' => 'listIds', 'segmentIds' => 'segmentIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'exclusionListIds' => 'setExclusionListIds', 'listIds' => 'setListIds', 'segmentIds' => 'setSegmentIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'exclusionListIds' => 'getExclusionListIds', 'listIds' => 'getListIds', 'segmentIds' => 'getSegmentIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['exclusionListIds'] = isset($data['exclusionListIds']) ? $data['exclusionListIds'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['segmentIds'] = isset($data['segmentIds']) ? $data['segmentIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets exclusionListIds * * @return int[] */ public function getExclusionListIds() { return $this->container['exclusionListIds']; } /** * Sets exclusionListIds * * @param int[] $exclusionListIds List ids which have to be excluded from a campaign * * @return $this */ public function setExclusionListIds($exclusionListIds) { $this->container['exclusionListIds'] = $exclusionListIds; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets segmentIds * * @return int[] */ public function getSegmentIds() { return $this->container['segmentIds']; } /** * Sets segmentIds * * @param int[] $segmentIds Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to. * * @return $this */ public function setSegmentIds($segmentIds) { $this->container['segmentIds'] = $segmentIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsEventReportEvents.php 0000644 00000030742 15021222673 0015560 0 ustar 00 <?php /** * GetSmsEventReportEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsEventReportEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsEventReportEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsEventReport_events'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'phoneNumber' => 'string', 'date' => 'string', 'messageId' => 'string', 'event' => 'string', 'reason' => 'string', 'reply' => 'string', 'tag' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'phoneNumber' => null, 'date' => null, 'messageId' => null, 'event' => null, 'reason' => null, 'reply' => null, 'tag' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'phoneNumber' => 'phoneNumber', 'date' => 'date', 'messageId' => 'messageId', 'event' => 'event', 'reason' => 'reason', 'reply' => 'reply', 'tag' => 'tag' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'phoneNumber' => 'setPhoneNumber', 'date' => 'setDate', 'messageId' => 'setMessageId', 'event' => 'setEvent', 'reason' => 'setReason', 'reply' => 'setReply', 'tag' => 'setTag' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'phoneNumber' => 'getPhoneNumber', 'date' => 'getDate', 'messageId' => 'getMessageId', 'event' => 'getEvent', 'reason' => 'getReason', 'reply' => 'getReply', 'tag' => 'getTag' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENT_BOUNCES = 'bounces'; const EVENT_HARD_BOUNCES = 'hardBounces'; const EVENT_SOFT_BOUNCES = 'softBounces'; const EVENT_DELIVERED = 'delivered'; const EVENT_SENT = 'sent'; const EVENT_ACCEPTED = 'accepted'; const EVENT_UNSUBSCRIPTION = 'unsubscription'; const EVENT_REPLIES = 'replies'; const EVENT_BLOCKED = 'blocked'; const EVENT_REJECTED = 'rejected'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventAllowableValues() { return [ self::EVENT_BOUNCES, self::EVENT_HARD_BOUNCES, self::EVENT_SOFT_BOUNCES, self::EVENT_DELIVERED, self::EVENT_SENT, self::EVENT_ACCEPTED, self::EVENT_UNSUBSCRIPTION, self::EVENT_REPLIES, self::EVENT_BLOCKED, self::EVENT_REJECTED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['event'] = isset($data['event']) ? $data['event'] : null; $this->container['reason'] = isset($data['reason']) ? $data['reason'] : null; $this->container['reply'] = isset($data['reply']) ? $data['reply'] : null; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getEventAllowableValues(); if (!is_null($this->container['event']) && !in_array($this->container['event'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets phoneNumber * * @return string */ public function getPhoneNumber() { return $this->container['phoneNumber']; } /** * Sets phoneNumber * * @param string $phoneNumber Phone number which has generated the event * * @return $this */ public function setPhoneNumber($phoneNumber) { $this->container['phoneNumber'] = $phoneNumber; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date UTC date-time on which the event has been generated * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message ID which generated the event * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets event * * @return string */ public function getEvent() { return $this->container['event']; } /** * Sets event * * @param string $event Event which occurred * * @return $this */ public function setEvent($event) { $allowedValues = $this->getEventAllowableValues(); if (!is_null($event) && !in_array($event, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['event'] = $event; return $this; } /** * Gets reason * * @return string */ public function getReason() { return $this->container['reason']; } /** * Sets reason * * @param string $reason Reason of bounce (only available if the event is hardbounce or softbounce) * * @return $this */ public function setReason($reason) { $this->container['reason'] = $reason; return $this; } /** * Gets reply * * @return string */ public function getReply() { return $this->container['reply']; } /** * Sets reply * * @param string $reply reply * * @return $this */ public function setReply($reply) { $this->container['reply'] = $reply; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the SMS which generated the event * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInboundEmailEventsByUuidAttachments.php 0000644 00000022434 15021222673 0020503 0 ustar 00 <?php /** * GetInboundEmailEventsByUuidAttachments * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInboundEmailEventsByUuidAttachments Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuidAttachments implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInboundEmailEventsByUuid_attachments'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'contentType' => 'string', 'contentId' => 'string', 'contentLength' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'contentType' => null, 'contentId' => null, 'contentLength' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'contentType' => 'contentType', 'contentId' => 'contentId', 'contentLength' => 'contentLength' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'contentType' => 'setContentType', 'contentId' => 'setContentId', 'contentLength' => 'setContentLength' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'contentType' => 'getContentType', 'contentId' => 'getContentId', 'contentLength' => 'getContentLength' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['contentType'] = isset($data['contentType']) ? $data['contentType'] : null; $this->container['contentId'] = isset($data['contentId']) ? $data['contentId'] : null; $this->container['contentLength'] = isset($data['contentLength']) ? $data['contentLength'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name filename specified in the Content-Disposition header of the attachment * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets contentType * * @return string */ public function getContentType() { return $this->container['contentType']; } /** * Sets contentType * * @param string $contentType value of the Content-Type header of the attachment * * @return $this */ public function setContentType($contentType) { $this->container['contentType'] = $contentType; return $this; } /** * Gets contentId * * @return string */ public function getContentId() { return $this->container['contentId']; } /** * Sets contentId * * @param string $contentId value of the Content-ID header of the attachment. * * @return $this */ public function setContentId($contentId) { $this->container['contentId'] = $contentId; return $this; } /** * Gets contentLength * * @return int */ public function getContentLength() { return $this->container['contentLength']; } /** * Sets contentLength * * @param int $contentLength size of the attachment in bytes * * @return $this */ public function setContentLength($contentLength) { $this->container['contentLength'] = $contentLength; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetBlockedDomains.php 0000644 00000016264 15021222673 0014314 0 ustar 00 <?php /** * GetBlockedDomains * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetBlockedDomains Class Doc Comment * * @category Class * @description list of blocked domains * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetBlockedDomains implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getBlockedDomains'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domains' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domains' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domains' => 'domains' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domains' => 'setDomains' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domains' => 'getDomains' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domains'] = isset($data['domains']) ? $data['domains'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['domains'] === null) { $invalidProperties[] = "'domains' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domains * * @return string[] */ public function getDomains() { return $this->container['domains']; } /** * Sets domains * * @param string[] $domains List of all blocked domains * * @return $this */ public function setDomains($domains) { $this->container['domains'] = $domains; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.php 0000644 00000017613 15021222673 0023310 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesLandingPage * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoFeaturesLandingPage Class Doc Comment * * @category Class * @description Landing page details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesLandingPage implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_features_landingPage'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'quantity' => 'int', 'remaining' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'quantity' => 'int64', 'remaining' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'quantity' => 'quantity', 'remaining' => 'remaining' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'quantity' => 'setQuantity', 'remaining' => 'setRemaining' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'quantity' => 'getQuantity', 'remaining' => 'getRemaining' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets quantity * * @return int */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param int $quantity Quantity of landing pages provided * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Available landing pages for use * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedListCampaignStats.php 0000644 00000020014 15021222673 0016475 0 ustar 00 <?php /** * GetExtendedListCampaignStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedListCampaignStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedListCampaignStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedList_campaignStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'stats' => '\Brevo\Client\Model\GetCampaignStats' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'stats' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'stats' => 'stats' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'stats' => 'setStats' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'stats' => 'getStats' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['stats'] = isset($data['stats']) ? $data['stats'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['stats'] === null) { $invalidProperties[] = "'stats' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets stats * * @return \Brevo\Client\Model\GetCampaignStats */ public function getStats() { return $this->container['stats']; } /** * Sets stats * * @param \Brevo\Client\Model\GetCampaignStats $stats stats * * @return $this */ public function setStats($stats) { $this->container['stats'] = $stats; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/WhatsappCampTemplate.php 0000644 00000034576 15021222673 0015070 0 ustar 00 <?php /** * WhatsappCampTemplate * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * WhatsappCampTemplate Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsappCampTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'WhatsappCampTemplate'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'category' => 'string', 'language' => 'string', 'containsButton' => 'bool', 'displayHeader' => 'bool', 'headerType' => 'string', 'components' => '\Brevo\Client\Model\ComponentItems[]', 'headerVariables' => '\Brevo\Client\Model\VariablesItems[]', 'bodyVariables' => '\Brevo\Client\Model\VariablesItems[]', 'buttonType' => 'string', 'hideFooter' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'category' => null, 'language' => null, 'containsButton' => null, 'displayHeader' => null, 'headerType' => null, 'components' => null, 'headerVariables' => null, 'bodyVariables' => null, 'buttonType' => null, 'hideFooter' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'category' => 'category', 'language' => 'language', 'containsButton' => 'contains_button', 'displayHeader' => 'display_header', 'headerType' => 'header_type', 'components' => 'components', 'headerVariables' => 'header_variables', 'bodyVariables' => 'body_variables', 'buttonType' => 'button_type', 'hideFooter' => 'hide_footer' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'category' => 'setCategory', 'language' => 'setLanguage', 'containsButton' => 'setContainsButton', 'displayHeader' => 'setDisplayHeader', 'headerType' => 'setHeaderType', 'components' => 'setComponents', 'headerVariables' => 'setHeaderVariables', 'bodyVariables' => 'setBodyVariables', 'buttonType' => 'setButtonType', 'hideFooter' => 'setHideFooter' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'category' => 'getCategory', 'language' => 'getLanguage', 'containsButton' => 'getContainsButton', 'displayHeader' => 'getDisplayHeader', 'headerType' => 'getHeaderType', 'components' => 'getComponents', 'headerVariables' => 'getHeaderVariables', 'bodyVariables' => 'getBodyVariables', 'buttonType' => 'getButtonType', 'hideFooter' => 'getHideFooter' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['category'] = isset($data['category']) ? $data['category'] : null; $this->container['language'] = isset($data['language']) ? $data['language'] : null; $this->container['containsButton'] = isset($data['containsButton']) ? $data['containsButton'] : null; $this->container['displayHeader'] = isset($data['displayHeader']) ? $data['displayHeader'] : null; $this->container['headerType'] = isset($data['headerType']) ? $data['headerType'] : null; $this->container['components'] = isset($data['components']) ? $data['components'] : null; $this->container['headerVariables'] = isset($data['headerVariables']) ? $data['headerVariables'] : null; $this->container['bodyVariables'] = isset($data['bodyVariables']) ? $data['bodyVariables'] : null; $this->container['buttonType'] = isset($data['buttonType']) ? $data['buttonType'] : null; $this->container['hideFooter'] = isset($data['hideFooter']) ? $data['hideFooter'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name name of the template * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets category * * @return string */ public function getCategory() { return $this->container['category']; } /** * Sets category * * @param string $category description of the template * * @return $this */ public function setCategory($category) { $this->container['category'] = $category; return $this; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language language of the template * * @return $this */ public function setLanguage($language) { $this->container['language'] = $language; return $this; } /** * Gets containsButton * * @return bool */ public function getContainsButton() { return $this->container['containsButton']; } /** * Sets containsButton * * @param bool $containsButton containsButton * * @return $this */ public function setContainsButton($containsButton) { $this->container['containsButton'] = $containsButton; return $this; } /** * Gets displayHeader * * @return bool */ public function getDisplayHeader() { return $this->container['displayHeader']; } /** * Sets displayHeader * * @param bool $displayHeader displayHeader * * @return $this */ public function setDisplayHeader($displayHeader) { $this->container['displayHeader'] = $displayHeader; return $this; } /** * Gets headerType * * @return string */ public function getHeaderType() { return $this->container['headerType']; } /** * Sets headerType * * @param string $headerType type of header * * @return $this */ public function setHeaderType($headerType) { $this->container['headerType'] = $headerType; return $this; } /** * Gets components * * @return \Brevo\Client\Model\ComponentItems[] */ public function getComponents() { return $this->container['components']; } /** * Sets components * * @param \Brevo\Client\Model\ComponentItems[] $components array of component item objects * * @return $this */ public function setComponents($components) { $this->container['components'] = $components; return $this; } /** * Gets headerVariables * * @return \Brevo\Client\Model\VariablesItems[] */ public function getHeaderVariables() { return $this->container['headerVariables']; } /** * Sets headerVariables * * @param \Brevo\Client\Model\VariablesItems[] $headerVariables array of variables item object * * @return $this */ public function setHeaderVariables($headerVariables) { $this->container['headerVariables'] = $headerVariables; return $this; } /** * Gets bodyVariables * * @return \Brevo\Client\Model\VariablesItems[] */ public function getBodyVariables() { return $this->container['bodyVariables']; } /** * Sets bodyVariables * * @param \Brevo\Client\Model\VariablesItems[] $bodyVariables array of variables item variables * * @return $this */ public function setBodyVariables($bodyVariables) { $this->container['bodyVariables'] = $bodyVariables; return $this; } /** * Gets buttonType * * @return string */ public function getButtonType() { return $this->container['buttonType']; } /** * Sets buttonType * * @param string $buttonType buttonType * * @return $this */ public function setButtonType($buttonType) { $this->container['buttonType'] = $buttonType; return $this; } /** * Gets hideFooter * * @return bool */ public function getHideFooter() { return $this->container['hideFooter']; } /** * Sets hideFooter * * @param bool $hideFooter hideFooter * * @return $this */ public function setHideFooter($hideFooter) { $this->container['hideFooter'] = $hideFooter; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedCampaignOverviewSender.php 0000644 00000020243 15021222673 0017516 0 ustar 00 <?php /** * GetExtendedCampaignOverviewSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedCampaignOverviewSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignOverviewSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedCampaignOverview_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Sender name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Sender email of the campaign * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Sender id of the campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateBatchCategoryModel.php 0000644 00000017643 15021222673 0016767 0 ustar 00 <?php /** * CreateUpdateBatchCategoryModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateBatchCategoryModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchCategoryModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateBatchCategoryModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'createdCount' => 'int', 'updatedCount' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'createdCount' => 'int64', 'updatedCount' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'createdCount' => 'createdCount', 'updatedCount' => 'updatedCount' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'createdCount' => 'setCreatedCount', 'updatedCount' => 'setUpdatedCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'createdCount' => 'getCreatedCount', 'updatedCount' => 'getUpdatedCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['createdCount'] = isset($data['createdCount']) ? $data['createdCount'] : null; $this->container['updatedCount'] = isset($data['updatedCount']) ? $data['updatedCount'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets createdCount * * @return int */ public function getCreatedCount() { return $this->container['createdCount']; } /** * Sets createdCount * * @param int $createdCount Number of the new created categories * * @return $this */ public function setCreatedCount($createdCount) { $this->container['createdCount'] = $createdCount; return $this; } /** * Gets updatedCount * * @return int */ public function getUpdatedCount() { return $this->container['updatedCount']; } /** * Sets updatedCount * * @param int $updatedCount Number of the existing categories updated * * @return $this */ public function setUpdatedCount($updatedCount) { $this->container['updatedCount'] = $updatedCount; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSendersListIps.php 0000644 00000021010 15021222673 0014332 0 ustar 00 <?php /** * GetSendersListIps * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSendersListIps Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersListIps implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSendersList_ips'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'ip' => 'string', 'domain' => 'string', 'weight' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'ip' => null, 'domain' => null, 'weight' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'ip' => 'ip', 'domain' => 'domain', 'weight' => 'weight' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'ip' => 'setIp', 'domain' => 'setDomain', 'weight' => 'setWeight' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'ip' => 'getIp', 'domain' => 'getDomain', 'weight' => 'getWeight' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; $this->container['weight'] = isset($data['weight']) ? $data['weight'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } if ($this->container['weight'] === null) { $invalidProperties[] = "'weight' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated IP available in your account * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Domain of the IP * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Gets weight * * @return int */ public function getWeight() { return $this->container['weight']; } /** * Sets weight * * @param int $weight Weight of the IP for this sender * * @return $this */ public function setWeight($weight) { $this->container['weight'] = $weight; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInvitedUsersListUsers.php 0000644 00000023247 15021222673 0015737 0 ustar 00 <?php /** * GetInvitedUsersListUsers * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInvitedUsersListUsers Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersListUsers implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInvitedUsersList_users'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'isOwner' => 'string', 'status' => 'string', 'featureAccess' => '\Brevo\Client\Model\GetInvitedUsersListFeatureAccess' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => null, 'isOwner' => null, 'status' => null, 'featureAccess' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'isOwner' => 'is_owner', 'status' => 'status', 'featureAccess' => 'feature_access' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'isOwner' => 'setIsOwner', 'status' => 'setStatus', 'featureAccess' => 'setFeatureAccess' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'isOwner' => 'getIsOwner', 'status' => 'getStatus', 'featureAccess' => 'getFeatureAccess' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['isOwner'] = isset($data['isOwner']) ? $data['isOwner'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['featureAccess'] = isset($data['featureAccess']) ? $data['featureAccess'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['isOwner'] === null) { $invalidProperties[] = "'isOwner' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } if ($this->container['featureAccess'] === null) { $invalidProperties[] = "'featureAccess' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the user. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets isOwner * * @return string */ public function getIsOwner() { return $this->container['isOwner']; } /** * Sets isOwner * * @param string $isOwner Flag for indicating is user owner of the organization. * * @return $this */ public function setIsOwner($isOwner) { $this->container['isOwner'] = $isOwner; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the invited user. * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Gets featureAccess * * @return \Brevo\Client\Model\GetInvitedUsersListFeatureAccess */ public function getFeatureAccess() { return $this->container['featureAccess']; } /** * Sets featureAccess * * @param \Brevo\Client\Model\GetInvitedUsersListFeatureAccess $featureAccess featureAccess * * @return $this */ public function setFeatureAccess($featureAccess) { $this->container['featureAccess'] = $featureAccess; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsappEventReport.php 0000644 00000016171 15021222673 0015420 0 ustar 00 <?php /** * GetWhatsappEventReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsappEventReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappEventReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsappEventReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'events' => '\Brevo\Client\Model\GetWhatsappEventReportEvents[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'events' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'events' => 'events' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'events' => 'setEvents' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'events' => 'getEvents' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['events'] = isset($data['events']) ? $data['events'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets events * * @return \Brevo\Client\Model\GetWhatsappEventReportEvents[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param \Brevo\Client\Model\GetWhatsappEventReportEvents[] $events events * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponse.php 0000644 00000022145 15021222673 0016064 0 ustar 00 <?php /** * SubAccountDetailsResponse * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponse Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'companyName' => 'string', 'planInfo' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfo' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => null, 'companyName' => null, 'planInfo' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'companyName' => 'companyName', 'planInfo' => 'planInfo' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'companyName' => 'setCompanyName', 'planInfo' => 'setPlanInfo' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'companyName' => 'getCompanyName', 'planInfo' => 'getPlanInfo' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['planInfo'] = isset($data['planInfo']) ? $data['planInfo'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the sub-account user * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email id of the sub-account organization * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Sub-account company name * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets planInfo * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfo */ public function getPlanInfo() { return $this->container['planInfo']; } /** * Sets planInfo * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfo $planInfo planInfo * * @return $this */ public function setPlanInfo($planInfo) { $this->container['planInfo'] = $planInfo; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedClientAddress.php 0000644 00000022567 15021222673 0015646 0 ustar 00 <?php /** * GetExtendedClientAddress * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedClientAddress Class Doc Comment * * @category Class * @description Address informations * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedClientAddress implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedClient_address'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'street' => 'string', 'city' => 'string', 'zipCode' => 'string', 'country' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'street' => null, 'city' => null, 'zipCode' => null, 'country' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'street' => 'street', 'city' => 'city', 'zipCode' => 'zipCode', 'country' => 'country' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'street' => 'setStreet', 'city' => 'setCity', 'zipCode' => 'setZipCode', 'country' => 'setCountry' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'street' => 'getStreet', 'city' => 'getCity', 'zipCode' => 'getZipCode', 'country' => 'getCountry' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['street'] = isset($data['street']) ? $data['street'] : null; $this->container['city'] = isset($data['city']) ? $data['city'] : null; $this->container['zipCode'] = isset($data['zipCode']) ? $data['zipCode'] : null; $this->container['country'] = isset($data['country']) ? $data['country'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['street'] === null) { $invalidProperties[] = "'street' can't be null"; } if ($this->container['city'] === null) { $invalidProperties[] = "'city' can't be null"; } if ($this->container['zipCode'] === null) { $invalidProperties[] = "'zipCode' can't be null"; } if ($this->container['country'] === null) { $invalidProperties[] = "'country' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets street * * @return string */ public function getStreet() { return $this->container['street']; } /** * Sets street * * @param string $street Street information * * @return $this */ public function setStreet($street) { $this->container['street'] = $street; return $this; } /** * Gets city * * @return string */ public function getCity() { return $this->container['city']; } /** * Sets city * * @param string $city City information * * @return $this */ public function setCity($city) { $this->container['city'] = $city; return $this; } /** * Gets zipCode * * @return string */ public function getZipCode() { return $this->container['zipCode']; } /** * Sets zipCode * * @param string $zipCode Zip Code information * * @return $this */ public function setZipCode($zipCode) { $this->container['zipCode'] = $zipCode; return $this; } /** * Gets country * * @return string */ public function getCountry() { return $this->container['country']; } /** * Sets country * * @param string $country Country information * * @return $this */ public function setCountry($country) { $this->container['country'] = $country; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AuthenticateDomainModel.php 0000644 00000017716 15021222673 0015530 0 ustar 00 <?php /** * AuthenticateDomainModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AuthenticateDomainModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AuthenticateDomainModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'authenticateDomainModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domainName' => 'string', 'message' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domainName' => null, 'message' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domainName' => 'domain_name', 'message' => 'message' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domainName' => 'setDomainName', 'message' => 'setMessage' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domainName' => 'getDomainName', 'message' => 'getMessage' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domainName'] = isset($data['domainName']) ? $data['domainName'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['domainName'] === null) { $invalidProperties[] = "'domainName' can't be null"; } if ($this->container['message'] === null) { $invalidProperties[] = "'message' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domainName * * @return string */ public function getDomainName() { return $this->container['domainName']; } /** * Sets domainName * * @param string $domainName Domain * * @return $this */ public function setDomainName($domainName) { $this->container['domainName'] = $domainName; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Success message * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateSmsCampaign.php 0000644 00000033264 15021222673 0014342 0 ustar 00 <?php /** * UpdateSmsCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateSmsCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmsCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateSmsCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'sender' => 'string', 'content' => 'string', 'recipients' => '\Brevo\Client\Model\CreateSmsCampaignRecipients', 'scheduledAt' => 'string', 'unicodeEnabled' => 'bool', 'organisationPrefix' => 'string', 'unsubscribeInstruction' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'sender' => null, 'content' => null, 'recipients' => null, 'scheduledAt' => null, 'unicodeEnabled' => null, 'organisationPrefix' => null, 'unsubscribeInstruction' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'sender' => 'sender', 'content' => 'content', 'recipients' => 'recipients', 'scheduledAt' => 'scheduledAt', 'unicodeEnabled' => 'unicodeEnabled', 'organisationPrefix' => 'organisationPrefix', 'unsubscribeInstruction' => 'unsubscribeInstruction' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'sender' => 'setSender', 'content' => 'setContent', 'recipients' => 'setRecipients', 'scheduledAt' => 'setScheduledAt', 'unicodeEnabled' => 'setUnicodeEnabled', 'organisationPrefix' => 'setOrganisationPrefix', 'unsubscribeInstruction' => 'setUnsubscribeInstruction' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'sender' => 'getSender', 'content' => 'getContent', 'recipients' => 'getRecipients', 'scheduledAt' => 'getScheduledAt', 'unicodeEnabled' => 'getUnicodeEnabled', 'organisationPrefix' => 'getOrganisationPrefix', 'unsubscribeInstruction' => 'getUnsubscribeInstruction' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['unicodeEnabled'] = isset($data['unicodeEnabled']) ? $data['unicodeEnabled'] : false; $this->container['organisationPrefix'] = isset($data['organisationPrefix']) ? $data['organisationPrefix'] : null; $this->container['unsubscribeInstruction'] = isset($data['unsubscribeInstruction']) ? $data['unsubscribeInstruction'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if (!is_null($this->container['sender']) && (mb_strlen($this->container['sender']) > 15)) { $invalidProperties[] = "invalid value for 'sender', the character length must be smaller than or equal to 15."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** * * @return $this */ public function setSender($sender) { if (!is_null($sender) && (mb_strlen($sender) > 15)) { throw new \InvalidArgumentException('invalid length for $sender when calling UpdateSmsCampaign., must be smaller than or equal to 15.'); } $this->container['sender'] = $sender; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS * * @return $this */ public function setContent($content) { $this->container['content'] = $content; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\CreateSmsCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\CreateSmsCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets unicodeEnabled * * @return bool */ public function getUnicodeEnabled() { return $this->container['unicodeEnabled']; } /** * Sets unicodeEnabled * * @param bool $unicodeEnabled Format of the message. It indicates whether the content should be treated as unicode or not. * * @return $this */ public function setUnicodeEnabled($unicodeEnabled) { $this->container['unicodeEnabled'] = $unicodeEnabled; return $this; } /** * Gets organisationPrefix * * @return string */ public function getOrganisationPrefix() { return $this->container['organisationPrefix']; } /** * Sets organisationPrefix * * @param string $organisationPrefix A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** * * @return $this */ public function setOrganisationPrefix($organisationPrefix) { $this->container['organisationPrefix'] = $organisationPrefix; return $this; } /** * Gets unsubscribeInstruction * * @return string */ public function getUnsubscribeInstruction() { return $this->container['unsubscribeInstruction']; } /** * Sets unsubscribeInstruction * * @param string $unsubscribeInstruction Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** * * @return $this */ public function setUnsubscribeInstruction($unsubscribeInstruction) { $this->container['unsubscribeInstruction'] = $unsubscribeInstruction; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateApiKeyResponse.php 0000644 00000017061 15021222673 0015017 0 ustar 00 <?php /** * CreateApiKeyResponse * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateApiKeyResponse Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateApiKeyResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createApiKeyResponse'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'status' => 'string', 'key' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'status' => null, 'key' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'status' => 'status', 'key' => 'key' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'status' => 'setStatus', 'key' => 'setKey' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'status' => 'getStatus', 'key' => 'getKey' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['key'] = isset($data['key']) ? $data['key'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the API operation. * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Gets key * * @return string */ public function getKey() { return $this->container['key']; } /** * Sets key * * @param string $key API Key * * @return $this */ public function setKey($key) { $this->container['key'] = $key; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendTestSms.php 0000644 00000016271 15021222673 0013210 0 ustar 00 <?php /** * SendTestSms * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendTestSms Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTestSms implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendTestSms'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'phoneNumber' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'phoneNumber' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'phoneNumber' => 'phoneNumber' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'phoneNumber' => 'setPhoneNumber' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'phoneNumber' => 'getPhoneNumber' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['phoneNumber'] = isset($data['phoneNumber']) ? $data['phoneNumber'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets phoneNumber * * @return string */ public function getPhoneNumber() { return $this->container['phoneNumber']; } /** * Sets phoneNumber * * @param string $phoneNumber Mobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted * * @return $this */ public function setPhoneNumber($phoneNumber) { $this->container['phoneNumber'] = $phoneNumber; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfoApiKeys.php 0000644 00000017460 15021222673 0014562 0 ustar 00 <?php /** * GetChildInfoApiKeys * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildInfoApiKeys Class Doc Comment * * @category Class * @description API Keys associated to child account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeys implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo_apiKeys'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'v2' => '\Brevo\Client\Model\GetChildInfoApiKeysV2[]', 'v3' => '\Brevo\Client\Model\GetChildInfoApiKeysV3[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'v2' => null, 'v3' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'v2' => 'v2', 'v3' => 'v3' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'v2' => 'setV2', 'v3' => 'setV3' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'v2' => 'getV2', 'v3' => 'getV3' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['v2'] = isset($data['v2']) ? $data['v2'] : null; $this->container['v3'] = isset($data['v3']) ? $data['v3'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['v2'] === null) { $invalidProperties[] = "'v2' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets v2 * * @return \Brevo\Client\Model\GetChildInfoApiKeysV2[] */ public function getV2() { return $this->container['v2']; } /** * Sets v2 * * @param \Brevo\Client\Model\GetChildInfoApiKeysV2[] $v2 v2 * * @return $this */ public function setV2($v2) { $this->container['v2'] = $v2; return $this; } /** * Gets v3 * * @return \Brevo\Client\Model\GetChildInfoApiKeysV3[] */ public function getV3() { return $this->container['v3']; } /** * Sets v3 * * @param \Brevo\Client\Model\GetChildInfoApiKeysV3[] $v3 v3 * * @return $this */ public function setV3($v3) { $this->container['v3'] = $v3; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestCampaignResult.php 0000644 00000036724 15021222673 0015022 0 ustar 00 <?php /** * AbTestCampaignResult * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestCampaignResult Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResult implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestCampaignResult'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'winningVersion' => 'string', 'winningCriteria' => 'string', 'winningSubjectLine' => 'string', 'openRate' => 'string', 'clickRate' => 'string', 'winningVersionRate' => 'string', 'statistics' => '\Brevo\Client\Model\AbTestCampaignResultStatistics', 'clickedLinks' => '\Brevo\Client\Model\AbTestCampaignResultClickedLinks' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'winningVersion' => null, 'winningCriteria' => null, 'winningSubjectLine' => null, 'openRate' => null, 'clickRate' => null, 'winningVersionRate' => null, 'statistics' => null, 'clickedLinks' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'winningVersion' => 'winningVersion', 'winningCriteria' => 'winningCriteria', 'winningSubjectLine' => 'winningSubjectLine', 'openRate' => 'openRate', 'clickRate' => 'clickRate', 'winningVersionRate' => 'winningVersionRate', 'statistics' => 'statistics', 'clickedLinks' => 'clickedLinks' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'winningVersion' => 'setWinningVersion', 'winningCriteria' => 'setWinningCriteria', 'winningSubjectLine' => 'setWinningSubjectLine', 'openRate' => 'setOpenRate', 'clickRate' => 'setClickRate', 'winningVersionRate' => 'setWinningVersionRate', 'statistics' => 'setStatistics', 'clickedLinks' => 'setClickedLinks' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'winningVersion' => 'getWinningVersion', 'winningCriteria' => 'getWinningCriteria', 'winningSubjectLine' => 'getWinningSubjectLine', 'openRate' => 'getOpenRate', 'clickRate' => 'getClickRate', 'winningVersionRate' => 'getWinningVersionRate', 'statistics' => 'getStatistics', 'clickedLinks' => 'getClickedLinks' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const WINNING_VERSION_NOT_AVAILABLE = 'notAvailable'; const WINNING_VERSION_PENDING = 'pending'; const WINNING_VERSION_TIE = 'tie'; const WINNING_VERSION_A = 'A'; const WINNING_VERSION_B = 'B'; const WINNING_CRITERIA_OPEN = 'Open'; const WINNING_CRITERIA_CLICK = 'Click'; /** * Gets allowable values of the enum * * @return string[] */ public function getWinningVersionAllowableValues() { return [ self::WINNING_VERSION_NOT_AVAILABLE, self::WINNING_VERSION_PENDING, self::WINNING_VERSION_TIE, self::WINNING_VERSION_A, self::WINNING_VERSION_B, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getWinningCriteriaAllowableValues() { return [ self::WINNING_CRITERIA_OPEN, self::WINNING_CRITERIA_CLICK, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['winningVersion'] = isset($data['winningVersion']) ? $data['winningVersion'] : null; $this->container['winningCriteria'] = isset($data['winningCriteria']) ? $data['winningCriteria'] : null; $this->container['winningSubjectLine'] = isset($data['winningSubjectLine']) ? $data['winningSubjectLine'] : null; $this->container['openRate'] = isset($data['openRate']) ? $data['openRate'] : null; $this->container['clickRate'] = isset($data['clickRate']) ? $data['clickRate'] : null; $this->container['winningVersionRate'] = isset($data['winningVersionRate']) ? $data['winningVersionRate'] : null; $this->container['statistics'] = isset($data['statistics']) ? $data['statistics'] : null; $this->container['clickedLinks'] = isset($data['clickedLinks']) ? $data['clickedLinks'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getWinningVersionAllowableValues(); if (!is_null($this->container['winningVersion']) && !in_array($this->container['winningVersion'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'winningVersion', must be one of '%s'", implode("', '", $allowedValues) ); } $allowedValues = $this->getWinningCriteriaAllowableValues(); if (!is_null($this->container['winningCriteria']) && !in_array($this->container['winningCriteria'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'winningCriteria', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets winningVersion * * @return string */ public function getWinningVersion() { return $this->container['winningVersion']; } /** * Sets winningVersion * * @param string $winningVersion Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. * * @return $this */ public function setWinningVersion($winningVersion) { $allowedValues = $this->getWinningVersionAllowableValues(); if (!is_null($winningVersion) && !in_array($winningVersion, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'winningVersion', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['winningVersion'] = $winningVersion; return $this; } /** * Gets winningCriteria * * @return string */ public function getWinningCriteria() { return $this->container['winningCriteria']; } /** * Sets winningCriteria * * @param string $winningCriteria Criteria choosen for winning version (Open/Click) * * @return $this */ public function setWinningCriteria($winningCriteria) { $allowedValues = $this->getWinningCriteriaAllowableValues(); if (!is_null($winningCriteria) && !in_array($winningCriteria, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'winningCriteria', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['winningCriteria'] = $winningCriteria; return $this; } /** * Gets winningSubjectLine * * @return string */ public function getWinningSubjectLine() { return $this->container['winningSubjectLine']; } /** * Sets winningSubjectLine * * @param string $winningSubjectLine Subject Line of current winning version * * @return $this */ public function setWinningSubjectLine($winningSubjectLine) { $this->container['winningSubjectLine'] = $winningSubjectLine; return $this; } /** * Gets openRate * * @return string */ public function getOpenRate() { return $this->container['openRate']; } /** * Sets openRate * * @param string $openRate Open rate for current winning version * * @return $this */ public function setOpenRate($openRate) { $this->container['openRate'] = $openRate; return $this; } /** * Gets clickRate * * @return string */ public function getClickRate() { return $this->container['clickRate']; } /** * Sets clickRate * * @param string $clickRate Click rate for current winning version * * @return $this */ public function setClickRate($clickRate) { $this->container['clickRate'] = $clickRate; return $this; } /** * Gets winningVersionRate * * @return string */ public function getWinningVersionRate() { return $this->container['winningVersionRate']; } /** * Sets winningVersionRate * * @param string $winningVersionRate Open/Click rate for the winner version * * @return $this */ public function setWinningVersionRate($winningVersionRate) { $this->container['winningVersionRate'] = $winningVersionRate; return $this; } /** * Gets statistics * * @return \Brevo\Client\Model\AbTestCampaignResultStatistics */ public function getStatistics() { return $this->container['statistics']; } /** * Sets statistics * * @param \Brevo\Client\Model\AbTestCampaignResultStatistics $statistics statistics * * @return $this */ public function setStatistics($statistics) { $this->container['statistics'] = $statistics; return $this; } /** * Gets clickedLinks * * @return \Brevo\Client\Model\AbTestCampaignResultClickedLinks */ public function getClickedLinks() { return $this->container['clickedLinks']; } /** * Sets clickedLinks * * @param \Brevo\Client\Model\AbTestCampaignResultClickedLinks $clickedLinks clickedLinks * * @return $this */ public function setClickedLinks($clickedLinks) { $this->container['clickedLinks'] = $clickedLinks; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedCampaignStats.php 0000644 00000033471 15021222673 0015654 0 ustar 00 <?php /** * GetExtendedCampaignStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedCampaignStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedCampaignStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'globalStats' => '\Brevo\Client\Model\GetExtendedCampaignStatsGlobalStats', 'campaignStats' => 'object[]', 'mirrorClick' => 'int', 'remaining' => 'int', 'linksStats' => 'object', 'statsByDomain' => '\Brevo\Client\Model\GetStatsByDomain', 'statsByDevice' => '\Brevo\Client\Model\GetStatsByDevice', 'statsByBrowser' => '\Brevo\Client\Model\GetStatsByBrowser' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'globalStats' => null, 'campaignStats' => null, 'mirrorClick' => 'int64', 'remaining' => 'int64', 'linksStats' => null, 'statsByDomain' => null, 'statsByDevice' => null, 'statsByBrowser' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'globalStats' => 'globalStats', 'campaignStats' => 'campaignStats', 'mirrorClick' => 'mirrorClick', 'remaining' => 'remaining', 'linksStats' => 'linksStats', 'statsByDomain' => 'statsByDomain', 'statsByDevice' => 'statsByDevice', 'statsByBrowser' => 'statsByBrowser' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'globalStats' => 'setGlobalStats', 'campaignStats' => 'setCampaignStats', 'mirrorClick' => 'setMirrorClick', 'remaining' => 'setRemaining', 'linksStats' => 'setLinksStats', 'statsByDomain' => 'setStatsByDomain', 'statsByDevice' => 'setStatsByDevice', 'statsByBrowser' => 'setStatsByBrowser' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'globalStats' => 'getGlobalStats', 'campaignStats' => 'getCampaignStats', 'mirrorClick' => 'getMirrorClick', 'remaining' => 'getRemaining', 'linksStats' => 'getLinksStats', 'statsByDomain' => 'getStatsByDomain', 'statsByDevice' => 'getStatsByDevice', 'statsByBrowser' => 'getStatsByBrowser' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['globalStats'] = isset($data['globalStats']) ? $data['globalStats'] : null; $this->container['campaignStats'] = isset($data['campaignStats']) ? $data['campaignStats'] : null; $this->container['mirrorClick'] = isset($data['mirrorClick']) ? $data['mirrorClick'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; $this->container['linksStats'] = isset($data['linksStats']) ? $data['linksStats'] : null; $this->container['statsByDomain'] = isset($data['statsByDomain']) ? $data['statsByDomain'] : null; $this->container['statsByDevice'] = isset($data['statsByDevice']) ? $data['statsByDevice'] : null; $this->container['statsByBrowser'] = isset($data['statsByBrowser']) ? $data['statsByBrowser'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['globalStats'] === null) { $invalidProperties[] = "'globalStats' can't be null"; } if ($this->container['campaignStats'] === null) { $invalidProperties[] = "'campaignStats' can't be null"; } if ($this->container['mirrorClick'] === null) { $invalidProperties[] = "'mirrorClick' can't be null"; } if ($this->container['remaining'] === null) { $invalidProperties[] = "'remaining' can't be null"; } if ($this->container['linksStats'] === null) { $invalidProperties[] = "'linksStats' can't be null"; } if ($this->container['statsByDomain'] === null) { $invalidProperties[] = "'statsByDomain' can't be null"; } if ($this->container['statsByDevice'] === null) { $invalidProperties[] = "'statsByDevice' can't be null"; } if ($this->container['statsByBrowser'] === null) { $invalidProperties[] = "'statsByBrowser' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets globalStats * * @return \Brevo\Client\Model\GetExtendedCampaignStatsGlobalStats */ public function getGlobalStats() { return $this->container['globalStats']; } /** * Sets globalStats * * @param \Brevo\Client\Model\GetExtendedCampaignStatsGlobalStats $globalStats globalStats * * @return $this */ public function setGlobalStats($globalStats) { $this->container['globalStats'] = $globalStats; return $this; } /** * Gets campaignStats * * @return object[] */ public function getCampaignStats() { return $this->container['campaignStats']; } /** * Sets campaignStats * * @param object[] $campaignStats List-wise statistics of the campaign. * * @return $this */ public function setCampaignStats($campaignStats) { $this->container['campaignStats'] = $campaignStats; return $this; } /** * Gets mirrorClick * * @return int */ public function getMirrorClick() { return $this->container['mirrorClick']; } /** * Sets mirrorClick * * @param int $mirrorClick Number of clicks on mirror link * * @return $this */ public function setMirrorClick($mirrorClick) { $this->container['mirrorClick'] = $mirrorClick; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Number of remaning emails to send * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Gets linksStats * * @return object */ public function getLinksStats() { return $this->container['linksStats']; } /** * Sets linksStats * * @param object $linksStats Statistics about the number of clicks for the links * * @return $this */ public function setLinksStats($linksStats) { $this->container['linksStats'] = $linksStats; return $this; } /** * Gets statsByDomain * * @return \Brevo\Client\Model\GetStatsByDomain */ public function getStatsByDomain() { return $this->container['statsByDomain']; } /** * Sets statsByDomain * * @param \Brevo\Client\Model\GetStatsByDomain $statsByDomain statsByDomain * * @return $this */ public function setStatsByDomain($statsByDomain) { $this->container['statsByDomain'] = $statsByDomain; return $this; } /** * Gets statsByDevice * * @return \Brevo\Client\Model\GetStatsByDevice */ public function getStatsByDevice() { return $this->container['statsByDevice']; } /** * Sets statsByDevice * * @param \Brevo\Client\Model\GetStatsByDevice $statsByDevice Statistics about the campaign on the basis of various devices * * @return $this */ public function setStatsByDevice($statsByDevice) { $this->container['statsByDevice'] = $statsByDevice; return $this; } /** * Gets statsByBrowser * * @return \Brevo\Client\Model\GetStatsByBrowser */ public function getStatsByBrowser() { return $this->container['statsByBrowser']; } /** * Sets statsByBrowser * * @param \Brevo\Client\Model\GetStatsByBrowser $statsByBrowser Statistics about the campaign on the basis of various browsers * * @return $this */ public function setStatsByBrowser($statsByBrowser) { $this->container['statsByBrowser'] = $statsByBrowser; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetIp.php 0000644 00000022153 15021222673 0012000 0 ustar 00 <?php /** * GetIp * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetIp Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIp implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getIp'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'ip' => 'string', 'active' => 'bool', 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'ip' => null, 'active' => null, 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'ip' => 'ip', 'active' => 'active', 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'ip' => 'setIp', 'active' => 'setActive', 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'ip' => 'getIp', 'active' => 'getActive', 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['active'] = isset($data['active']) ? $data['active'] : null; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } if ($this->container['active'] === null) { $invalidProperties[] = "'active' can't be null"; } if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the dedicated IP * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated IP * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets active * * @return bool */ public function getActive() { return $this->container['active']; } /** * Sets active * * @param bool $active Status of the IP (true=active, false=inactive) * * @return $this */ public function setActive($active) { $this->container['active'] = $active; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Domain associated to the IP * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateCategoryModel.php 0000644 00000015676 15021222673 0014666 0 ustar 00 <?php /** * CreateCategoryModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateCategoryModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCategoryModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createCategoryModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the category when a new category is created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAllExternalFeeds.php 0000644 00000017251 15021222673 0014615 0 ustar 00 <?php /** * GetAllExternalFeeds * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAllExternalFeeds Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAllExternalFeeds implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAllExternalFeeds'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'feeds' => '\Brevo\Client\Model\GetAllExternalFeedsFeeds[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => null, 'feeds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'feeds' => 'feeds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'feeds' => 'setFeeds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'feeds' => 'getFeeds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['feeds'] = isset($data['feeds']) ? $data['feeds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Total number of batches * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets feeds * * @return \Brevo\Client\Model\GetAllExternalFeedsFeeds[] */ public function getFeeds() { return $this->container['feeds']; } /** * Sets feeds * * @param \Brevo\Client\Model\GetAllExternalFeedsFeeds[] $feeds feeds * * @return $this */ public function setFeeds($feeds) { $this->container['feeds'] = $feeds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSms.php 0000644 00000024200 15021222673 0012337 0 ustar 00 <?php /** * SendSms * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSms Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSms implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSms'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'reference' => 'string', 'messageId' => 'int', 'smsCount' => 'int', 'usedCredits' => 'float', 'remainingCredits' => 'float' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'reference' => null, 'messageId' => 'int64', 'smsCount' => 'int64', 'usedCredits' => 'float', 'remainingCredits' => 'float' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'reference' => 'reference', 'messageId' => 'messageId', 'smsCount' => 'smsCount', 'usedCredits' => 'usedCredits', 'remainingCredits' => 'remainingCredits' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'reference' => 'setReference', 'messageId' => 'setMessageId', 'smsCount' => 'setSmsCount', 'usedCredits' => 'setUsedCredits', 'remainingCredits' => 'setRemainingCredits' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'reference' => 'getReference', 'messageId' => 'getMessageId', 'smsCount' => 'getSmsCount', 'usedCredits' => 'getUsedCredits', 'remainingCredits' => 'getRemainingCredits' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['reference'] = isset($data['reference']) ? $data['reference'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['smsCount'] = isset($data['smsCount']) ? $data['smsCount'] : null; $this->container['usedCredits'] = isset($data['usedCredits']) ? $data['usedCredits'] : null; $this->container['remainingCredits'] = isset($data['remainingCredits']) ? $data['remainingCredits'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['reference'] === null) { $invalidProperties[] = "'reference' can't be null"; } if ($this->container['messageId'] === null) { $invalidProperties[] = "'messageId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets reference * * @return string */ public function getReference() { return $this->container['reference']; } /** * Sets reference * * @param string $reference reference * * @return $this */ public function setReference($reference) { $this->container['reference'] = $reference; return $this; } /** * Gets messageId * * @return int */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param int $messageId messageId * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets smsCount * * @return int */ public function getSmsCount() { return $this->container['smsCount']; } /** * Sets smsCount * * @param int $smsCount Count of SMS's to send multiple text messages * * @return $this */ public function setSmsCount($smsCount) { $this->container['smsCount'] = $smsCount; return $this; } /** * Gets usedCredits * * @return float */ public function getUsedCredits() { return $this->container['usedCredits']; } /** * Sets usedCredits * * @param float $usedCredits SMS credits used per text message * * @return $this */ public function setUsedCredits($usedCredits) { $this->container['usedCredits'] = $usedCredits; return $this; } /** * Gets remainingCredits * * @return float */ public function getRemainingCredits() { return $this->container['remainingCredits']; } /** * Sets remainingCredits * * @param float $remainingCredits Remaining SMS credits of the user * * @return $this */ public function setRemainingCredits($remainingCredits) { $this->container['remainingCredits'] = $remainingCredits; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Pipelines.php 0000644 00000014710 15021222673 0012720 0 ustar 00 <?php /** * Pipelines * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Pipelines Class Doc Comment * * @category Class * @description List of pipeline * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Pipelines implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Pipelines'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = parent::listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailReplyTo1.php 0000644 00000017640 15021222673 0015102 0 ustar 00 <?php /** * SendSmtpEmailReplyTo1 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailReplyTo1 Class Doc Comment * * @category Class * @description Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"} * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailReplyTo1 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_replyTo_1'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address in reply to * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name in reply to. Maximum allowed characters are 70. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/TaskList.php 0000644 00000016012 15021222673 0012523 0 ustar 00 <?php /** * TaskList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * TaskList Class Doc Comment * * @category Class * @description List of tasks * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'TaskList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'items' => '\Brevo\Client\Model\Task[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'items' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'items' => 'items' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'items' => 'setItems' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'items' => 'getItems' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['items'] = isset($data['items']) ? $data['items'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets items * * @return \Brevo\Client\Model\Task[] */ public function getItems() { return $this->container['items']; } /** * Sets items * * @param \Brevo\Client\Model\Task[] $items List of tasks * * @return $this */ public function setItems($items) { $this->container['items'] = $items; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfoApiKeysV3.php 0000644 00000017410 15021222673 0014766 0 ustar 00 <?php /** * GetChildInfoApiKeysV3 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildInfoApiKeysV3 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeysV3 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo_apiKeys_v3'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'key' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'key' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'key' => 'key' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'key' => 'setKey' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'key' => 'getKey' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['key'] = isset($data['key']) ? $data['key'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['key'] === null) { $invalidProperties[] = "'key' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the key for version 3 * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets key * * @return string */ public function getKey() { return $this->container['key']; } /** * Sets key * * @param string $key API Key for version 3 * * @return $this */ public function setKey($key) { $this->container['key'] = $key; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/DealAttributesInner.php 0000644 00000024047 15021222673 0014704 0 ustar 00 <?php /** * DealAttributesInner * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * DealAttributesInner Class Doc Comment * * @category Class * @description List of attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealAttributesInner implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'DealAttributes_inner'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'internalName' => 'string', 'label' => 'string', 'attributeTypeName' => 'string', 'attributeOptions' => 'object[]', 'isRequired' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'internalName' => null, 'label' => null, 'attributeTypeName' => null, 'attributeOptions' => null, 'isRequired' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'internalName' => 'internalName', 'label' => 'label', 'attributeTypeName' => 'attributeTypeName', 'attributeOptions' => 'attributeOptions', 'isRequired' => 'isRequired' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'internalName' => 'setInternalName', 'label' => 'setLabel', 'attributeTypeName' => 'setAttributeTypeName', 'attributeOptions' => 'setAttributeOptions', 'isRequired' => 'setIsRequired' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'internalName' => 'getInternalName', 'label' => 'getLabel', 'attributeTypeName' => 'getAttributeTypeName', 'attributeOptions' => 'getAttributeOptions', 'isRequired' => 'getIsRequired' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['internalName'] = isset($data['internalName']) ? $data['internalName'] : null; $this->container['label'] = isset($data['label']) ? $data['label'] : null; $this->container['attributeTypeName'] = isset($data['attributeTypeName']) ? $data['attributeTypeName'] : null; $this->container['attributeOptions'] = isset($data['attributeOptions']) ? $data['attributeOptions'] : null; $this->container['isRequired'] = isset($data['isRequired']) ? $data['isRequired'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets internalName * * @return string */ public function getInternalName() { return $this->container['internalName']; } /** * Sets internalName * * @param string $internalName internalName * * @return $this */ public function setInternalName($internalName) { $this->container['internalName'] = $internalName; return $this; } /** * Gets label * * @return string */ public function getLabel() { return $this->container['label']; } /** * Sets label * * @param string $label label * * @return $this */ public function setLabel($label) { $this->container['label'] = $label; return $this; } /** * Gets attributeTypeName * * @return string */ public function getAttributeTypeName() { return $this->container['attributeTypeName']; } /** * Sets attributeTypeName * * @param string $attributeTypeName attributeTypeName * * @return $this */ public function setAttributeTypeName($attributeTypeName) { $this->container['attributeTypeName'] = $attributeTypeName; return $this; } /** * Gets attributeOptions * * @return object[] */ public function getAttributeOptions() { return $this->container['attributeOptions']; } /** * Sets attributeOptions * * @param object[] $attributeOptions attributeOptions * * @return $this */ public function setAttributeOptions($attributeOptions) { $this->container['attributeOptions'] = $attributeOptions; return $this; } /** * Gets isRequired * * @return bool */ public function getIsRequired() { return $this->container['isRequired']; } /** * Sets isRequired * * @param bool $isRequired isRequired * * @return $this */ public function setIsRequired($isRequired) { $this->container['isRequired'] = $isRequired; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestVersionClicks.php 0000644 00000015015 15021222673 0014650 0 ustar 00 <?php /** * AbTestVersionClicks * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestVersionClicks Class Doc Comment * * @category Class * @description Information on clicked links for a particular version * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionClicks implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestVersionClicks'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsappCampaignsCampaigns.php 0000644 00000042104 15021222673 0016663 0 ustar 00 <?php /** * GetWhatsappCampaignsCampaigns * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsappCampaignsCampaigns Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaignsCampaigns implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsappCampaigns_campaigns'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'campaignName' => 'string', 'templateId' => 'string', 'campaignStatus' => 'string', 'scheduledAt' => 'string', 'errorReason' => 'string', 'invalidatedContacts' => 'int', 'readPercentage' => 'float', 'stats' => '\Brevo\Client\Model\WhatsappCampStats', 'createdAt' => 'string', 'modifiedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'campaignName' => null, 'templateId' => null, 'campaignStatus' => null, 'scheduledAt' => null, 'errorReason' => null, 'invalidatedContacts' => 'int64', 'readPercentage' => 'float', 'stats' => null, 'createdAt' => null, 'modifiedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'campaignName' => 'campaignName', 'templateId' => 'templateId', 'campaignStatus' => 'campaignStatus', 'scheduledAt' => 'scheduledAt', 'errorReason' => 'errorReason', 'invalidatedContacts' => 'invalidatedContacts', 'readPercentage' => 'readPercentage', 'stats' => 'stats', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'campaignName' => 'setCampaignName', 'templateId' => 'setTemplateId', 'campaignStatus' => 'setCampaignStatus', 'scheduledAt' => 'setScheduledAt', 'errorReason' => 'setErrorReason', 'invalidatedContacts' => 'setInvalidatedContacts', 'readPercentage' => 'setReadPercentage', 'stats' => 'setStats', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'campaignName' => 'getCampaignName', 'templateId' => 'getTemplateId', 'campaignStatus' => 'getCampaignStatus', 'scheduledAt' => 'getScheduledAt', 'errorReason' => 'getErrorReason', 'invalidatedContacts' => 'getInvalidatedContacts', 'readPercentage' => 'getReadPercentage', 'stats' => 'getStats', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CAMPAIGN_STATUS_DRAFT = 'draft'; const CAMPAIGN_STATUS_SCHEDULED = 'scheduled'; const CAMPAIGN_STATUS_PENDING = 'pending'; const CAMPAIGN_STATUS_APPROVED = 'approved'; const CAMPAIGN_STATUS_RUNNING = 'running'; const CAMPAIGN_STATUS_SUSPENDED = 'suspended'; const CAMPAIGN_STATUS_REJECTED = 'rejected'; const CAMPAIGN_STATUS_SENT = 'sent'; /** * Gets allowable values of the enum * * @return string[] */ public function getCampaignStatusAllowableValues() { return [ self::CAMPAIGN_STATUS_DRAFT, self::CAMPAIGN_STATUS_SCHEDULED, self::CAMPAIGN_STATUS_PENDING, self::CAMPAIGN_STATUS_APPROVED, self::CAMPAIGN_STATUS_RUNNING, self::CAMPAIGN_STATUS_SUSPENDED, self::CAMPAIGN_STATUS_REJECTED, self::CAMPAIGN_STATUS_SENT, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['campaignName'] = isset($data['campaignName']) ? $data['campaignName'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['campaignStatus'] = isset($data['campaignStatus']) ? $data['campaignStatus'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['errorReason'] = isset($data['errorReason']) ? $data['errorReason'] : null; $this->container['invalidatedContacts'] = isset($data['invalidatedContacts']) ? $data['invalidatedContacts'] : null; $this->container['readPercentage'] = isset($data['readPercentage']) ? $data['readPercentage'] : null; $this->container['stats'] = isset($data['stats']) ? $data['stats'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['campaignName'] === null) { $invalidProperties[] = "'campaignName' can't be null"; } if ($this->container['templateId'] === null) { $invalidProperties[] = "'templateId' can't be null"; } if ($this->container['campaignStatus'] === null) { $invalidProperties[] = "'campaignStatus' can't be null"; } $allowedValues = $this->getCampaignStatusAllowableValues(); if (!is_null($this->container['campaignStatus']) && !in_array($this->container['campaignStatus'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['scheduledAt'] === null) { $invalidProperties[] = "'scheduledAt' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the WhatsApp Campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets campaignName * * @return string */ public function getCampaignName() { return $this->container['campaignName']; } /** * Sets campaignName * * @param string $campaignName Name of the WhatsApp Campaign * * @return $this */ public function setCampaignName($campaignName) { $this->container['campaignName'] = $campaignName; return $this; } /** * Gets templateId * * @return string */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param string $templateId Id of the WhatsApp template * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets campaignStatus * * @return string */ public function getCampaignStatus() { return $this->container['campaignStatus']; } /** * Sets campaignStatus * * @param string $campaignStatus Status of the WhatsApp Campaign * * @return $this */ public function setCampaignStatus($campaignStatus) { $allowedValues = $this->getCampaignStatusAllowableValues(); if (!in_array($campaignStatus, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['campaignStatus'] = $campaignStatus; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets errorReason * * @return string */ public function getErrorReason() { return $this->container['errorReason']; } /** * Sets errorReason * * @param string $errorReason Error reason in the campaign creation * * @return $this */ public function setErrorReason($errorReason) { $this->container['errorReason'] = $errorReason; return $this; } /** * Gets invalidatedContacts * * @return int */ public function getInvalidatedContacts() { return $this->container['invalidatedContacts']; } /** * Sets invalidatedContacts * * @param int $invalidatedContacts Count of invalidated contacts * * @return $this */ public function setInvalidatedContacts($invalidatedContacts) { $this->container['invalidatedContacts'] = $invalidatedContacts; return $this; } /** * Gets readPercentage * * @return float */ public function getReadPercentage() { return $this->container['readPercentage']; } /** * Sets readPercentage * * @param float $readPercentage Read percentage of the the WhatsApp campaign created * * @return $this */ public function setReadPercentage($readPercentage) { $this->container['readPercentage'] = $readPercentage; return $this; } /** * Gets stats * * @return \Brevo\Client\Model\WhatsappCampStats */ public function getStats() { return $this->container['stats']; } /** * Sets stats * * @param \Brevo\Client\Model\WhatsappCampStats $stats stats * * @return $this */ public function setStats($stats) { $this->container['stats'] = $stats; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the whatsapp template (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmail.php 0000644 00000051145 15021222673 0013500 0 ustar 00 <?php /** * SendSmtpEmail * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmail Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmail implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sender' => '\Brevo\Client\Model\SendSmtpEmailSender', 'to' => '\Brevo\Client\Model\SendSmtpEmailTo[]', 'bcc' => '\Brevo\Client\Model\SendSmtpEmailBcc[]', 'cc' => '\Brevo\Client\Model\SendSmtpEmailCc[]', 'htmlContent' => 'string', 'textContent' => 'string', 'subject' => 'string', 'replyTo' => '\Brevo\Client\Model\SendSmtpEmailReplyTo', 'attachment' => '\Brevo\Client\Model\SendSmtpEmailAttachment[]', 'headers' => 'object', 'templateId' => 'int', 'params' => 'object', 'messageVersions' => '\Brevo\Client\Model\SendSmtpEmailMessageVersions[]', 'tags' => 'string[]', 'scheduledAt' => '\DateTime', 'batchId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sender' => null, 'to' => null, 'bcc' => null, 'cc' => null, 'htmlContent' => null, 'textContent' => null, 'subject' => null, 'replyTo' => null, 'attachment' => null, 'headers' => null, 'templateId' => 'int64', 'params' => null, 'messageVersions' => null, 'tags' => null, 'scheduledAt' => 'date-time', 'batchId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sender' => 'sender', 'to' => 'to', 'bcc' => 'bcc', 'cc' => 'cc', 'htmlContent' => 'htmlContent', 'textContent' => 'textContent', 'subject' => 'subject', 'replyTo' => 'replyTo', 'attachment' => 'attachment', 'headers' => 'headers', 'templateId' => 'templateId', 'params' => 'params', 'messageVersions' => 'messageVersions', 'tags' => 'tags', 'scheduledAt' => 'scheduledAt', 'batchId' => 'batchId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sender' => 'setSender', 'to' => 'setTo', 'bcc' => 'setBcc', 'cc' => 'setCc', 'htmlContent' => 'setHtmlContent', 'textContent' => 'setTextContent', 'subject' => 'setSubject', 'replyTo' => 'setReplyTo', 'attachment' => 'setAttachment', 'headers' => 'setHeaders', 'templateId' => 'setTemplateId', 'params' => 'setParams', 'messageVersions' => 'setMessageVersions', 'tags' => 'setTags', 'scheduledAt' => 'setScheduledAt', 'batchId' => 'setBatchId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sender' => 'getSender', 'to' => 'getTo', 'bcc' => 'getBcc', 'cc' => 'getCc', 'htmlContent' => 'getHtmlContent', 'textContent' => 'getTextContent', 'subject' => 'getSubject', 'replyTo' => 'getReplyTo', 'attachment' => 'getAttachment', 'headers' => 'getHeaders', 'templateId' => 'getTemplateId', 'params' => 'getParams', 'messageVersions' => 'getMessageVersions', 'tags' => 'getTags', 'scheduledAt' => 'getScheduledAt', 'batchId' => 'getBatchId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['to'] = isset($data['to']) ? $data['to'] : null; $this->container['bcc'] = isset($data['bcc']) ? $data['bcc'] : null; $this->container['cc'] = isset($data['cc']) ? $data['cc'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['textContent'] = isset($data['textContent']) ? $data['textContent'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['attachment'] = isset($data['attachment']) ? $data['attachment'] : null; $this->container['headers'] = isset($data['headers']) ? $data['headers'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['params'] = isset($data['params']) ? $data['params'] : null; $this->container['messageVersions'] = isset($data['messageVersions']) ? $data['messageVersions'] : null; $this->container['tags'] = isset($data['tags']) ? $data['tags'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sender * * @return \Brevo\Client\Model\SendSmtpEmailSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\SendSmtpEmailSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets to * * @return \Brevo\Client\Model\SendSmtpEmailTo[] */ public function getTo() { return $this->container['to']; } /** * Sets to * * @param \Brevo\Client\Model\SendSmtpEmailTo[] $to Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] * * @return $this */ public function setTo($to) { $this->container['to'] = $to; return $this; } /** * Gets bcc * * @return \Brevo\Client\Model\SendSmtpEmailBcc[] */ public function getBcc() { return $this->container['bcc']; } /** * Sets bcc * * @param \Brevo\Client\Model\SendSmtpEmailBcc[] $bcc List of email addresses and names (optional) of the recipients in bcc * * @return $this */ public function setBcc($bcc) { $this->container['bcc'] = $bcc; return $this; } /** * Gets cc * * @return \Brevo\Client\Model\SendSmtpEmailCc[] */ public function getCc() { return $this->container['cc']; } /** * Sets cc * * @param \Brevo\Client\Model\SendSmtpEmailCc[] $cc List of email addresses and names (optional) of the recipients in cc * * @return $this */ public function setCc($cc) { $this->container['cc'] = $cc; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets textContent * * @return string */ public function getTextContent() { return $this->container['textContent']; } /** * Sets textContent * * @param string $textContent Plain Text body of the message ( Ignored if 'templateId' is passed ) * * @return $this */ public function setTextContent($textContent) { $this->container['textContent'] = $textContent; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the message. Mandatory if 'templateId' is not passed * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets replyTo * * @return \Brevo\Client\Model\SendSmtpEmailReplyTo */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param \Brevo\Client\Model\SendSmtpEmailReplyTo $replyTo replyTo * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets attachment * * @return \Brevo\Client\Model\SendSmtpEmailAttachment[] */ public function getAttachment() { return $this->container['attachment']; } /** * Sets attachment * * @param \Brevo\Client\Model\SendSmtpEmailAttachment[] $attachment Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) * * @return $this */ public function setAttachment($attachment) { $this->container['attachment'] = $attachment; return $this; } /** * Gets headers * * @return object */ public function getHeaders() { return $this->container['headers']; } /** * Sets headers * * @param object $headers Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. * * @return $this */ public function setHeaders($headers) { $this->container['headers'] = $headers; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Id of the template. * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets params * * @return object */ public function getParams() { return $this->container['params']; } /** * Sets params * * @param object $params Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. * * @return $this */ public function setParams($params) { $this->container['params'] = $params; return $this; } /** * Gets messageVersions * * @return \Brevo\Client\Model\SendSmtpEmailMessageVersions[] */ public function getMessageVersions() { return $this->container['messageVersions']; } /** * Sets messageVersions * * @param \Brevo\Client\Model\SendSmtpEmailMessageVersions[] $messageVersions You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails * * @return $this */ public function setMessageVersions($messageVersions) { $this->container['messageVersions'] = $messageVersions; return $this; } /** * Gets tags * * @return string[] */ public function getTags() { return $this->container['tags']; } /** * Sets tags * * @param string[] $tags Tag your emails to find them more easily * * @return $this */ public function setTags($tags) { $this->container['tags'] = $tags; return $this; } /** * Gets scheduledAt * * @return \DateTime */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param \DateTime $scheduledAt UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets batchId * * @return string */ public function getBatchId() { return $this->container['batchId']; } /** * Sets batchId * * @param string $batchId Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. * * @return $this */ public function setBatchId($batchId) { $this->container['batchId'] = $batchId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body5.php 0000644 00000023127 15021222673 0011754 0 ustar 00 <?php /** * Body5 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body5 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body5 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_5'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'linkContactIds' => 'int[]', 'unlinkContactIds' => 'int[]', 'linkCompanyIds' => 'string[]', 'unlinkCompanyIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'linkContactIds' => 'int64', 'unlinkContactIds' => 'int64', 'linkCompanyIds' => null, 'unlinkCompanyIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'linkContactIds' => 'linkContactIds', 'unlinkContactIds' => 'unlinkContactIds', 'linkCompanyIds' => 'linkCompanyIds', 'unlinkCompanyIds' => 'unlinkCompanyIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'linkContactIds' => 'setLinkContactIds', 'unlinkContactIds' => 'setUnlinkContactIds', 'linkCompanyIds' => 'setLinkCompanyIds', 'unlinkCompanyIds' => 'setUnlinkCompanyIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'linkContactIds' => 'getLinkContactIds', 'unlinkContactIds' => 'getUnlinkContactIds', 'linkCompanyIds' => 'getLinkCompanyIds', 'unlinkCompanyIds' => 'getUnlinkCompanyIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['linkContactIds'] = isset($data['linkContactIds']) ? $data['linkContactIds'] : null; $this->container['unlinkContactIds'] = isset($data['unlinkContactIds']) ? $data['unlinkContactIds'] : null; $this->container['linkCompanyIds'] = isset($data['linkCompanyIds']) ? $data['linkCompanyIds'] : null; $this->container['unlinkCompanyIds'] = isset($data['unlinkCompanyIds']) ? $data['unlinkCompanyIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets linkContactIds * * @return int[] */ public function getLinkContactIds() { return $this->container['linkContactIds']; } /** * Sets linkContactIds * * @param int[] $linkContactIds Contact ids for contacts to be linked with deal * * @return $this */ public function setLinkContactIds($linkContactIds) { $this->container['linkContactIds'] = $linkContactIds; return $this; } /** * Gets unlinkContactIds * * @return int[] */ public function getUnlinkContactIds() { return $this->container['unlinkContactIds']; } /** * Sets unlinkContactIds * * @param int[] $unlinkContactIds Contact ids for contacts to be unlinked from deal * * @return $this */ public function setUnlinkContactIds($unlinkContactIds) { $this->container['unlinkContactIds'] = $unlinkContactIds; return $this; } /** * Gets linkCompanyIds * * @return string[] */ public function getLinkCompanyIds() { return $this->container['linkCompanyIds']; } /** * Sets linkCompanyIds * * @param string[] $linkCompanyIds Company ids to be linked with deal * * @return $this */ public function setLinkCompanyIds($linkCompanyIds) { $this->container['linkCompanyIds'] = $linkCompanyIds; return $this; } /** * Gets unlinkCompanyIds * * @return string[] */ public function getUnlinkCompanyIds() { return $this->container['unlinkCompanyIds']; } /** * Sets unlinkCompanyIds * * @param string[] $unlinkCompanyIds Company ids to be unlinked from deal * * @return $this */ public function setUnlinkCompanyIds($unlinkCompanyIds) { $this->container['unlinkCompanyIds'] = $unlinkCompanyIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateCoupons.php 0000644 00000020022 15021222673 0013533 0 ustar 00 <?php /** * CreateCoupons * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateCoupons Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCoupons implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createCoupons'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'collectionId' => 'string', 'coupons' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'collectionId' => 'uuidv4', 'coupons' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'collectionId' => 'collectionId', 'coupons' => 'coupons' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'collectionId' => 'setCollectionId', 'coupons' => 'setCoupons' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'collectionId' => 'getCollectionId', 'coupons' => 'getCoupons' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['collectionId'] = isset($data['collectionId']) ? $data['collectionId'] : null; $this->container['coupons'] = isset($data['coupons']) ? $data['coupons'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['collectionId'] === null) { $invalidProperties[] = "'collectionId' can't be null"; } if ($this->container['coupons'] === null) { $invalidProperties[] = "'coupons' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets collectionId * * @return string */ public function getCollectionId() { return $this->container['collectionId']; } /** * Sets collectionId * * @param string $collectionId The id of the coupon collection for which the coupons will be created * * @return $this */ public function setCollectionId($collectionId) { $this->container['collectionId'] = $collectionId; return $this; } /** * Gets coupons * * @return string[] */ public function getCoupons() { return $this->container['coupons']; } /** * Sets coupons * * @param string[] $coupons coupons * * @return $this */ public function setCoupons($coupons) { $this->container['coupons'] = $coupons; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacEmailContent.php 0000644 00000027615 15021222673 0015336 0 ustar 00 <?php /** * GetTransacEmailContent * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacEmailContent Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailContent implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacEmailContent'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'subject' => 'string', 'templateId' => 'int', 'date' => 'string', 'events' => '\Brevo\Client\Model\GetTransacEmailContentEvents[]', 'body' => 'string', 'attachmentCount' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'subject' => null, 'templateId' => 'int64', 'date' => null, 'events' => null, 'body' => null, 'attachmentCount' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'subject' => 'subject', 'templateId' => 'templateId', 'date' => 'date', 'events' => 'events', 'body' => 'body', 'attachmentCount' => 'attachmentCount' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'subject' => 'setSubject', 'templateId' => 'setTemplateId', 'date' => 'setDate', 'events' => 'setEvents', 'body' => 'setBody', 'attachmentCount' => 'setAttachmentCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'subject' => 'getSubject', 'templateId' => 'getTemplateId', 'date' => 'getDate', 'events' => 'getEvents', 'body' => 'getBody', 'attachmentCount' => 'getAttachmentCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['events'] = isset($data['events']) ? $data['events'] : null; $this->container['body'] = isset($data['body']) ? $data['body'] : null; $this->container['attachmentCount'] = isset($data['attachmentCount']) ? $data['attachmentCount'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['subject'] === null) { $invalidProperties[] = "'subject' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['events'] === null) { $invalidProperties[] = "'events' can't be null"; } if ($this->container['body'] === null) { $invalidProperties[] = "'body' can't be null"; } if ($this->container['attachmentCount'] === null) { $invalidProperties[] = "'attachmentCount' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address to which transactional email has been sent * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the sent email * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Id of the template * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date Date on which transactional email was sent * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets events * * @return \Brevo\Client\Model\GetTransacEmailContentEvents[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param \Brevo\Client\Model\GetTransacEmailContentEvents[] $events Series of events which occurred on the transactional email * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Gets body * * @return string */ public function getBody() { return $this->container['body']; } /** * Sets body * * @param string $body Actual content of the transactional email that has been sent * * @return $this */ public function setBody($body) { $this->container['body'] = $body; return $this; } /** * Gets attachmentCount * * @return int */ public function getAttachmentCount() { return $this->container['attachmentCount']; } /** * Sets attachmentCount * * @param int $attachmentCount Count of the attachments that were sent in the email * * @return $this */ public function setAttachmentCount($attachmentCount) { $this->container['attachmentCount'] = $attachmentCount; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCredits.php 0000644 00000017603 15021222673 0021034 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoCredits * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoCredits Class Doc Comment * * @category Class * @description Credits quota and remaining credits on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoCredits implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_credits'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sms' => 'int', 'emails' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCreditsEmails' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sms' => 'int64', 'emails' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sms' => 'sms', 'emails' => 'emails' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sms' => 'setSms', 'emails' => 'setEmails' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sms' => 'getSms', 'emails' => 'getEmails' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['emails'] = isset($data['emails']) ? $data['emails'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sms * * @return int */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param int $sms SMS credits remaining on the sub-account * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets emails * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCreditsEmails */ public function getEmails() { return $this->container['emails']; } /** * Sets emails * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCreditsEmails $emails emails * * @return $this */ public function setEmails($emails) { $this->container['emails'] = $emails; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestContactExportCustomContactFilter.php 0000644 00000044130 15021222673 0021012 0 ustar 00 <?php /** * RequestContactExportCustomContactFilter * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestContactExportCustomContactFilter Class Doc Comment * * @category Class * @description Set the filter for the contacts to be exported. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactExportCustomContactFilter implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestContactExport_customContactFilter'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'actionForContacts' => 'string', 'actionForEmailCampaigns' => 'string', 'actionForSmsCampaigns' => 'string', 'listId' => 'int', 'emailCampaignId' => 'int', 'smsCampaignId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'actionForContacts' => null, 'actionForEmailCampaigns' => null, 'actionForSmsCampaigns' => null, 'listId' => 'int64', 'emailCampaignId' => 'int64', 'smsCampaignId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'actionForContacts' => 'actionForContacts', 'actionForEmailCampaigns' => 'actionForEmailCampaigns', 'actionForSmsCampaigns' => 'actionForSmsCampaigns', 'listId' => 'listId', 'emailCampaignId' => 'emailCampaignId', 'smsCampaignId' => 'smsCampaignId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'actionForContacts' => 'setActionForContacts', 'actionForEmailCampaigns' => 'setActionForEmailCampaigns', 'actionForSmsCampaigns' => 'setActionForSmsCampaigns', 'listId' => 'setListId', 'emailCampaignId' => 'setEmailCampaignId', 'smsCampaignId' => 'setSmsCampaignId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'actionForContacts' => 'getActionForContacts', 'actionForEmailCampaigns' => 'getActionForEmailCampaigns', 'actionForSmsCampaigns' => 'getActionForSmsCampaigns', 'listId' => 'getListId', 'emailCampaignId' => 'getEmailCampaignId', 'smsCampaignId' => 'getSmsCampaignId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const ACTION_FOR_CONTACTS_ALL_CONTACTS = 'allContacts'; const ACTION_FOR_CONTACTS_SUBSCRIBED = 'subscribed'; const ACTION_FOR_CONTACTS_UNSUBSCRIBED = 'unsubscribed'; const ACTION_FOR_CONTACTS_UNSUBSCRIBED_PER_LIST = 'unsubscribedPerList'; const ACTION_FOR_EMAIL_CAMPAIGNS_OPENERS = 'openers'; const ACTION_FOR_EMAIL_CAMPAIGNS_NON_OPENERS = 'nonOpeners'; const ACTION_FOR_EMAIL_CAMPAIGNS_CLICKERS = 'clickers'; const ACTION_FOR_EMAIL_CAMPAIGNS_NON_CLICKERS = 'nonClickers'; const ACTION_FOR_EMAIL_CAMPAIGNS_UNSUBSCRIBED = 'unsubscribed'; const ACTION_FOR_EMAIL_CAMPAIGNS_HARD_BOUNCES = 'hardBounces'; const ACTION_FOR_EMAIL_CAMPAIGNS_SOFT_BOUNCES = 'softBounces'; const ACTION_FOR_SMS_CAMPAIGNS_HARD_BOUNCES = 'hardBounces'; const ACTION_FOR_SMS_CAMPAIGNS_SOFT_BOUNCES = 'softBounces'; const ACTION_FOR_SMS_CAMPAIGNS_UNSUBSCRIBED = 'unsubscribed'; /** * Gets allowable values of the enum * * @return string[] */ public function getActionForContactsAllowableValues() { return [ self::ACTION_FOR_CONTACTS_ALL_CONTACTS, self::ACTION_FOR_CONTACTS_SUBSCRIBED, self::ACTION_FOR_CONTACTS_UNSUBSCRIBED, self::ACTION_FOR_CONTACTS_UNSUBSCRIBED_PER_LIST, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getActionForEmailCampaignsAllowableValues() { return [ self::ACTION_FOR_EMAIL_CAMPAIGNS_OPENERS, self::ACTION_FOR_EMAIL_CAMPAIGNS_NON_OPENERS, self::ACTION_FOR_EMAIL_CAMPAIGNS_CLICKERS, self::ACTION_FOR_EMAIL_CAMPAIGNS_NON_CLICKERS, self::ACTION_FOR_EMAIL_CAMPAIGNS_UNSUBSCRIBED, self::ACTION_FOR_EMAIL_CAMPAIGNS_HARD_BOUNCES, self::ACTION_FOR_EMAIL_CAMPAIGNS_SOFT_BOUNCES, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getActionForSmsCampaignsAllowableValues() { return [ self::ACTION_FOR_SMS_CAMPAIGNS_HARD_BOUNCES, self::ACTION_FOR_SMS_CAMPAIGNS_SOFT_BOUNCES, self::ACTION_FOR_SMS_CAMPAIGNS_UNSUBSCRIBED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['actionForContacts'] = isset($data['actionForContacts']) ? $data['actionForContacts'] : null; $this->container['actionForEmailCampaigns'] = isset($data['actionForEmailCampaigns']) ? $data['actionForEmailCampaigns'] : null; $this->container['actionForSmsCampaigns'] = isset($data['actionForSmsCampaigns']) ? $data['actionForSmsCampaigns'] : null; $this->container['listId'] = isset($data['listId']) ? $data['listId'] : null; $this->container['emailCampaignId'] = isset($data['emailCampaignId']) ? $data['emailCampaignId'] : null; $this->container['smsCampaignId'] = isset($data['smsCampaignId']) ? $data['smsCampaignId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getActionForContactsAllowableValues(); if (!is_null($this->container['actionForContacts']) && !in_array($this->container['actionForContacts'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'actionForContacts', must be one of '%s'", implode("', '", $allowedValues) ); } $allowedValues = $this->getActionForEmailCampaignsAllowableValues(); if (!is_null($this->container['actionForEmailCampaigns']) && !in_array($this->container['actionForEmailCampaigns'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'actionForEmailCampaigns', must be one of '%s'", implode("', '", $allowedValues) ); } $allowedValues = $this->getActionForSmsCampaignsAllowableValues(); if (!is_null($this->container['actionForSmsCampaigns']) && !in_array($this->container['actionForSmsCampaigns'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'actionForSmsCampaigns', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets actionForContacts * * @return string */ public function getActionForContacts() { return $this->container['actionForContacts']; } /** * Sets actionForContacts * * @param string $actionForContacts Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. * * @return $this */ public function setActionForContacts($actionForContacts) { $allowedValues = $this->getActionForContactsAllowableValues(); if (!is_null($actionForContacts) && !in_array($actionForContacts, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'actionForContacts', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['actionForContacts'] = $actionForContacts; return $this; } /** * Gets actionForEmailCampaigns * * @return string */ public function getActionForEmailCampaigns() { return $this->container['actionForEmailCampaigns']; } /** * Sets actionForEmailCampaigns * * @param string $actionForEmailCampaigns Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). * * @return $this */ public function setActionForEmailCampaigns($actionForEmailCampaigns) { $allowedValues = $this->getActionForEmailCampaignsAllowableValues(); if (!is_null($actionForEmailCampaigns) && !in_array($actionForEmailCampaigns, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'actionForEmailCampaigns', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['actionForEmailCampaigns'] = $actionForEmailCampaigns; return $this; } /** * Gets actionForSmsCampaigns * * @return string */ public function getActionForSmsCampaigns() { return $this->container['actionForSmsCampaigns']; } /** * Sets actionForSmsCampaigns * * @param string $actionForSmsCampaigns Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. * * @return $this */ public function setActionForSmsCampaigns($actionForSmsCampaigns) { $allowedValues = $this->getActionForSmsCampaignsAllowableValues(); if (!is_null($actionForSmsCampaigns) && !in_array($actionForSmsCampaigns, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'actionForSmsCampaigns', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['actionForSmsCampaigns'] = $actionForSmsCampaigns; return $this; } /** * Gets listId * * @return int */ public function getListId() { return $this->container['listId']; } /** * Sets listId * * @param int $listId Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter. * * @return $this */ public function setListId($listId) { $this->container['listId'] = $listId; return $this; } /** * Gets emailCampaignId * * @return int */ public function getEmailCampaignId() { return $this->container['emailCampaignId']; } /** * Sets emailCampaignId * * @param int $emailCampaignId Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. * * @return $this */ public function setEmailCampaignId($emailCampaignId) { $this->container['emailCampaignId'] = $emailCampaignId; return $this; } /** * Gets smsCampaignId * * @return int */ public function getSmsCampaignId() { return $this->container['smsCampaignId']; } /** * Sets smsCampaignId * * @param int $smsCampaignId Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. * * @return $this */ public function setSmsCampaignId($smsCampaignId) { $this->container['smsCampaignId'] = $smsCampaignId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Company.php 0000644 00000022407 15021222673 0012400 0 ustar 00 <?php /** * Company * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Company Class Doc Comment * * @category Class * @description Company Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Company implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Company'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'attributes' => 'object', 'linkedContactsIds' => 'int[]', 'linkedDealsIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'attributes' => null, 'linkedContactsIds' => null, 'linkedDealsIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'attributes' => 'attributes', 'linkedContactsIds' => 'linkedContactsIds', 'linkedDealsIds' => 'linkedDealsIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'attributes' => 'setAttributes', 'linkedContactsIds' => 'setLinkedContactsIds', 'linkedDealsIds' => 'setLinkedDealsIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'attributes' => 'getAttributes', 'linkedContactsIds' => 'getLinkedContactsIds', 'linkedDealsIds' => 'getLinkedDealsIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['linkedContactsIds'] = isset($data['linkedContactsIds']) ? $data['linkedContactsIds'] : null; $this->container['linkedDealsIds'] = isset($data['linkedDealsIds']) ? $data['linkedDealsIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique company id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Company attributes with values * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets linkedContactsIds * * @return int[] */ public function getLinkedContactsIds() { return $this->container['linkedContactsIds']; } /** * Sets linkedContactsIds * * @param int[] $linkedContactsIds Contact ids for contacts linked to this company * * @return $this */ public function setLinkedContactsIds($linkedContactsIds) { $this->container['linkedContactsIds'] = $linkedContactsIds; return $this; } /** * Gets linkedDealsIds * * @return string[] */ public function getLinkedDealsIds() { return $this->container['linkedDealsIds']; } /** * Sets linkedDealsIds * * @param string[] $linkedDealsIds Deals ids for companies linked to this company * * @return $this */ public function setLinkedDealsIds($linkedDealsIds) { $this->container['linkedDealsIds'] = $linkedDealsIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Contact.php 0000644 00000030065 15021222673 0012364 0 ustar 00 <?php /** * Contact * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Contact Class Doc Comment * * @category Class * @description Contact Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Contact implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Contact'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'virtualNextTask' => 'object', 'email' => 'string', 'assignToId' => 'string', 'contactsId' => 'int', 'crmLists' => 'object', 'attributes' => 'object', 'createdAt' => '\DateTime', 'updatedAt' => '\DateTime' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'virtualNextTask' => null, 'email' => null, 'assignToId' => null, 'contactsId' => null, 'crmLists' => null, 'attributes' => null, 'createdAt' => 'date-time', 'updatedAt' => 'date-time' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'virtualNextTask' => 'virtualNextTask', 'email' => 'email', 'assignToId' => 'assignToId', 'contactsId' => 'contactsId', 'crmLists' => 'crmLists', 'attributes' => 'attributes', 'createdAt' => 'createdAt', 'updatedAt' => 'updatedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'virtualNextTask' => 'setVirtualNextTask', 'email' => 'setEmail', 'assignToId' => 'setAssignToId', 'contactsId' => 'setContactsId', 'crmLists' => 'setCrmLists', 'attributes' => 'setAttributes', 'createdAt' => 'setCreatedAt', 'updatedAt' => 'setUpdatedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'virtualNextTask' => 'getVirtualNextTask', 'email' => 'getEmail', 'assignToId' => 'getAssignToId', 'contactsId' => 'getContactsId', 'crmLists' => 'getCrmLists', 'attributes' => 'getAttributes', 'createdAt' => 'getCreatedAt', 'updatedAt' => 'getUpdatedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['virtualNextTask'] = isset($data['virtualNextTask']) ? $data['virtualNextTask'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null; $this->container['contactsId'] = isset($data['contactsId']) ? $data['contactsId'] : null; $this->container['crmLists'] = isset($data['crmLists']) ? $data['crmLists'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['crmLists'] === null) { $invalidProperties[] = "'crmLists' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets virtualNextTask * * @return object */ public function getVirtualNextTask() { return $this->container['virtualNextTask']; } /** * Sets virtualNextTask * * @param object $virtualNextTask Next incomplete task of contact * * @return $this */ public function setVirtualNextTask($virtualNextTask) { $this->container['virtualNextTask'] = $virtualNextTask; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Contact email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets assignToId * * @return string */ public function getAssignToId() { return $this->container['assignToId']; } /** * Sets assignToId * * @param string $assignToId User id to whom contact is assigned * * @return $this */ public function setAssignToId($assignToId) { $this->container['assignToId'] = $assignToId; return $this; } /** * Gets contactsId * * @return int */ public function getContactsId() { return $this->container['contactsId']; } /** * Sets contactsId * * @param int $contactsId Contact id * * @return $this */ public function setContactsId($contactsId) { $this->container['contactsId'] = $contactsId; return $this; } /** * Gets crmLists * * @return object */ public function getCrmLists() { return $this->container['crmLists']; } /** * Sets crmLists * * @param object $crmLists CRM lists in which contact is added * * @return $this */ public function setCrmLists($crmLists) { $this->container['crmLists'] = $crmLists; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Contact attributes e.g firstname / lastname / SMS etc. * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Contact created date/time * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets updatedAt * * @return \DateTime */ public function getUpdatedAt() { return $this->container['updatedAt']; } /** * Sets updatedAt * * @param \DateTime $updatedAt Contact updated date/time * * @return $this */ public function setUpdatedAt($updatedAt) { $this->container['updatedAt'] = $updatedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInboundEmailEventsEvents.php 0000644 00000022642 15021222673 0016353 0 ustar 00 <?php /** * GetInboundEmailEventsEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInboundEmailEventsEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInboundEmailEvents_events'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'uuid' => 'string', 'date' => '\DateTime', 'sender' => 'string', 'recipient' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'uuid' => 'uuid', 'date' => 'date-time', 'sender' => 'email', 'recipient' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'uuid' => 'uuid', 'date' => 'date', 'sender' => 'sender', 'recipient' => 'recipient' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'uuid' => 'setUuid', 'date' => 'setDate', 'sender' => 'setSender', 'recipient' => 'setRecipient' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'uuid' => 'getUuid', 'date' => 'getDate', 'sender' => 'getSender', 'recipient' => 'getRecipient' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['uuid'] = isset($data['uuid']) ? $data['uuid'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['recipient'] = isset($data['recipient']) ? $data['recipient'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['uuid'] === null) { $invalidProperties[] = "'uuid' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['recipient'] === null) { $invalidProperties[] = "'recipient' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets uuid * * @return string */ public function getUuid() { return $this->container['uuid']; } /** * Sets uuid * * @param string $uuid UUID that can be used to fetch additional data * * @return $this */ public function setUuid($uuid) { $this->container['uuid'] = $uuid; return $this; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Date when email was received on SMTP relay * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Sender’s email address * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets recipient * * @return string */ public function getRecipient() { return $this->container['recipient']; } /** * Sets recipient * * @param string $recipient Recipient’s email address * * @return $this */ public function setRecipient($recipient) { $this->container['recipient'] = $recipient; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWATemplatesTemplates.php 0000644 00000031035 15021222673 0015474 0 ustar 00 <?php /** * GetWATemplatesTemplates * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWATemplatesTemplates Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWATemplatesTemplates implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWATemplates_templates'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'status' => 'string', 'language' => 'string', 'category' => 'string', 'errorReason' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'name' => null, 'status' => null, 'language' => null, 'category' => null, 'errorReason' => null, 'createdAt' => null, 'modifiedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'status' => 'status', 'language' => 'language', 'category' => 'category', 'errorReason' => 'errorReason', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'status' => 'setStatus', 'language' => 'setLanguage', 'category' => 'setCategory', 'errorReason' => 'setErrorReason', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'status' => 'getStatus', 'language' => 'getLanguage', 'category' => 'getCategory', 'errorReason' => 'getErrorReason', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['language'] = isset($data['language']) ? $data['language'] : null; $this->container['category'] = isset($data['category']) ? $data['category'] : null; $this->container['errorReason'] = isset($data['errorReason']) ? $data['errorReason'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } if ($this->container['language'] === null) { $invalidProperties[] = "'language' can't be null"; } if ($this->container['category'] === null) { $invalidProperties[] = "'category' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id id of the template * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the WhatsApp template * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the WhatsApp template * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language Language in which template exists * * @return $this */ public function setLanguage($language) { $this->container['language'] = $language; return $this; } /** * Gets category * * @return string */ public function getCategory() { return $this->container['category']; } /** * Sets category * * @param string $category category of the template * * @return $this */ public function setCategory($category) { $this->container['category'] = $category; return $this; } /** * Gets errorReason * * @return string */ public function getErrorReason() { return $this->container['errorReason']; } /** * Sets errorReason * * @param string $errorReason Error reason in the template creation * * @return $this */ public function setErrorReason($errorReason) { $this->container['errorReason'] = $errorReason; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Deal.php 0000644 00000022500 15021222673 0011631 0 ustar 00 <?php /** * Deal * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Deal Class Doc Comment * * @category Class * @description Deal Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Deal implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Deal'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'attributes' => 'object', 'linkedContactsIds' => 'int[]', 'linkedCompaniesIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'attributes' => null, 'linkedContactsIds' => null, 'linkedCompaniesIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'attributes' => 'attributes', 'linkedContactsIds' => 'linkedContactsIds', 'linkedCompaniesIds' => 'linkedCompaniesIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'attributes' => 'setAttributes', 'linkedContactsIds' => 'setLinkedContactsIds', 'linkedCompaniesIds' => 'setLinkedCompaniesIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'attributes' => 'getAttributes', 'linkedContactsIds' => 'getLinkedContactsIds', 'linkedCompaniesIds' => 'getLinkedCompaniesIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['linkedContactsIds'] = isset($data['linkedContactsIds']) ? $data['linkedContactsIds'] : null; $this->container['linkedCompaniesIds'] = isset($data['linkedCompaniesIds']) ? $data['linkedCompaniesIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique deal id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Deal attributes with values * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets linkedContactsIds * * @return int[] */ public function getLinkedContactsIds() { return $this->container['linkedContactsIds']; } /** * Sets linkedContactsIds * * @param int[] $linkedContactsIds Contact ids for contacts linked to this deal * * @return $this */ public function setLinkedContactsIds($linkedContactsIds) { $this->container['linkedContactsIds'] = $linkedContactsIds; return $this; } /** * Gets linkedCompaniesIds * * @return string[] */ public function getLinkedCompaniesIds() { return $this->container['linkedCompaniesIds']; } /** * Sets linkedCompaniesIds * * @param string[] $linkedCompaniesIds Companies ids for companies linked to this deal * * @return $this */ public function setLinkedCompaniesIds($linkedCompaniesIds) { $this->container['linkedCompaniesIds'] = $linkedCompaniesIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ManageIp.php 0000644 00000015563 15021222673 0012460 0 ustar 00 <?php /** * ManageIp * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ManageIp Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ManageIp implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'manageIp'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated ID * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsappCampaignOverview.php 0000644 00000036675 15021222673 0016424 0 ustar 00 <?php /** * GetWhatsappCampaignOverview * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsappCampaignOverview Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaignOverview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsappCampaignOverview'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'campaignName' => 'string', 'campaignStatus' => 'string', 'scheduledAt' => 'string', 'senderNumber' => 'string', 'stats' => '\Brevo\Client\Model\WhatsappCampStats', 'template' => '\Brevo\Client\Model\WhatsappCampTemplate', 'createdAt' => 'string', 'modifiedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'campaignName' => null, 'campaignStatus' => null, 'scheduledAt' => null, 'senderNumber' => null, 'stats' => null, 'template' => null, 'createdAt' => null, 'modifiedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'campaignName' => 'campaignName', 'campaignStatus' => 'campaignStatus', 'scheduledAt' => 'scheduledAt', 'senderNumber' => 'senderNumber', 'stats' => 'stats', 'template' => 'template', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'campaignName' => 'setCampaignName', 'campaignStatus' => 'setCampaignStatus', 'scheduledAt' => 'setScheduledAt', 'senderNumber' => 'setSenderNumber', 'stats' => 'setStats', 'template' => 'setTemplate', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'campaignName' => 'getCampaignName', 'campaignStatus' => 'getCampaignStatus', 'scheduledAt' => 'getScheduledAt', 'senderNumber' => 'getSenderNumber', 'stats' => 'getStats', 'template' => 'getTemplate', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CAMPAIGN_STATUS_DRAFT = 'draft'; const CAMPAIGN_STATUS_SCHEDULED = 'scheduled'; const CAMPAIGN_STATUS_PENDING = 'pending'; const CAMPAIGN_STATUS_APPROVED = 'approved'; const CAMPAIGN_STATUS_RUNNING = 'running'; const CAMPAIGN_STATUS_SUSPENDED = 'suspended'; const CAMPAIGN_STATUS_REJECTED = 'rejected'; const CAMPAIGN_STATUS_SENT = 'sent'; /** * Gets allowable values of the enum * * @return string[] */ public function getCampaignStatusAllowableValues() { return [ self::CAMPAIGN_STATUS_DRAFT, self::CAMPAIGN_STATUS_SCHEDULED, self::CAMPAIGN_STATUS_PENDING, self::CAMPAIGN_STATUS_APPROVED, self::CAMPAIGN_STATUS_RUNNING, self::CAMPAIGN_STATUS_SUSPENDED, self::CAMPAIGN_STATUS_REJECTED, self::CAMPAIGN_STATUS_SENT, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['campaignName'] = isset($data['campaignName']) ? $data['campaignName'] : null; $this->container['campaignStatus'] = isset($data['campaignStatus']) ? $data['campaignStatus'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['senderNumber'] = isset($data['senderNumber']) ? $data['senderNumber'] : null; $this->container['stats'] = isset($data['stats']) ? $data['stats'] : null; $this->container['template'] = isset($data['template']) ? $data['template'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['campaignName'] === null) { $invalidProperties[] = "'campaignName' can't be null"; } if ($this->container['campaignStatus'] === null) { $invalidProperties[] = "'campaignStatus' can't be null"; } $allowedValues = $this->getCampaignStatusAllowableValues(); if (!is_null($this->container['campaignStatus']) && !in_array($this->container['campaignStatus'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['senderNumber'] === null) { $invalidProperties[] = "'senderNumber' can't be null"; } if ($this->container['template'] === null) { $invalidProperties[] = "'template' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the WhatsApp Campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets campaignName * * @return string */ public function getCampaignName() { return $this->container['campaignName']; } /** * Sets campaignName * * @param string $campaignName Name of the WhatsApp Campaign * * @return $this */ public function setCampaignName($campaignName) { $this->container['campaignName'] = $campaignName; return $this; } /** * Gets campaignStatus * * @return string */ public function getCampaignStatus() { return $this->container['campaignStatus']; } /** * Sets campaignStatus * * @param string $campaignStatus Status of the WhatsApp Campaign * * @return $this */ public function setCampaignStatus($campaignStatus) { $allowedValues = $this->getCampaignStatusAllowableValues(); if (!in_array($campaignStatus, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'campaignStatus', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['campaignStatus'] = $campaignStatus; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets senderNumber * * @return string */ public function getSenderNumber() { return $this->container['senderNumber']; } /** * Sets senderNumber * * @param string $senderNumber Sender of the WhatsApp Campaign * * @return $this */ public function setSenderNumber($senderNumber) { $this->container['senderNumber'] = $senderNumber; return $this; } /** * Gets stats * * @return \Brevo\Client\Model\WhatsappCampStats */ public function getStats() { return $this->container['stats']; } /** * Sets stats * * @param \Brevo\Client\Model\WhatsappCampStats $stats stats * * @return $this */ public function setStats($stats) { $this->container['stats'] = $stats; return $this; } /** * Gets template * * @return \Brevo\Client\Model\WhatsappCampTemplate */ public function getTemplate() { return $this->container['template']; } /** * Sets template * * @param \Brevo\Client\Model\WhatsappCampTemplate $template template * * @return $this */ public function setTemplate($template) { $this->container['template'] = $template; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateList.php 0000644 00000017357 15021222673 0013060 0 ustar 00 <?php /** * UpdateList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'folderId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'folderId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'folderId' => 'folderId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'folderId' => 'setFolderId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'folderId' => 'getFolderId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['folderId'] = isset($data['folderId']) ? $data['folderId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the list. Either of the two parameters (name, folderId) can be updated at a time. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets folderId * * @return int */ public function getFolderId() { return $this->container['folderId']; } /** * Sets folderId * * @param int $folderId Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time. * * @return $this */ public function setFolderId($folderId) { $this->container['folderId'] = $folderId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacBlockedContacts.php 0000644 00000017457 15021222673 0016021 0 ustar 00 <?php /** * GetTransacBlockedContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacBlockedContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacBlockedContacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'contacts' => '\Brevo\Client\Model\GetTransacBlockedContactsContacts[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => 'int64', 'contacts' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'contacts' => 'contacts' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'contacts' => 'setContacts' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'contacts' => 'getContacts' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['contacts'] = isset($data['contacts']) ? $data['contacts'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Count of blocked or unsubscribed contact * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets contacts * * @return \Brevo\Client\Model\GetTransacBlockedContactsContacts[] */ public function getContacts() { return $this->container['contacts']; } /** * Sets contacts * * @param \Brevo\Client\Model\GetTransacBlockedContactsContacts[] $contacts contacts * * @return $this */ public function setContacts($contacts) { $this->container['contacts'] = $contacts; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfoStatistics.php 0000644 00000022010 15021222673 0015332 0 ustar 00 <?php /** * GetChildInfoStatistics * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildInfoStatistics Class Doc Comment * * @category Class * @description Statistics about your child account activity * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoStatistics implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo_statistics'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'previousMonthTotalSent' => 'int', 'currentMonthTotalSent' => 'int', 'totalSent' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'previousMonthTotalSent' => 'int64', 'currentMonthTotalSent' => 'int64', 'totalSent' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'previousMonthTotalSent' => 'previousMonthTotalSent', 'currentMonthTotalSent' => 'currentMonthTotalSent', 'totalSent' => 'totalSent' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'previousMonthTotalSent' => 'setPreviousMonthTotalSent', 'currentMonthTotalSent' => 'setCurrentMonthTotalSent', 'totalSent' => 'setTotalSent' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'previousMonthTotalSent' => 'getPreviousMonthTotalSent', 'currentMonthTotalSent' => 'getCurrentMonthTotalSent', 'totalSent' => 'getTotalSent' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['previousMonthTotalSent'] = isset($data['previousMonthTotalSent']) ? $data['previousMonthTotalSent'] : null; $this->container['currentMonthTotalSent'] = isset($data['currentMonthTotalSent']) ? $data['currentMonthTotalSent'] : null; $this->container['totalSent'] = isset($data['totalSent']) ? $data['totalSent'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets previousMonthTotalSent * * @return int */ public function getPreviousMonthTotalSent() { return $this->container['previousMonthTotalSent']; } /** * Sets previousMonthTotalSent * * @param int $previousMonthTotalSent Overall emails sent for the previous month * * @return $this */ public function setPreviousMonthTotalSent($previousMonthTotalSent) { $this->container['previousMonthTotalSent'] = $previousMonthTotalSent; return $this; } /** * Gets currentMonthTotalSent * * @return int */ public function getCurrentMonthTotalSent() { return $this->container['currentMonthTotalSent']; } /** * Sets currentMonthTotalSent * * @param int $currentMonthTotalSent Overall emails sent for current month * * @return $this */ public function setCurrentMonthTotalSent($currentMonthTotalSent) { $this->container['currentMonthTotalSent'] = $currentMonthTotalSent; return $this; } /** * Gets totalSent * * @return int */ public function getTotalSent() { return $this->container['totalSent']; } /** * Sets totalSent * * @param int $totalSent Overall emails sent for since the account exists * * @return $this */ public function setTotalSent($totalSent) { $this->container['totalSent'] = $totalSent; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CompanyAttributes.php 0000644 00000014752 15021222673 0014453 0 ustar 00 <?php /** * CompanyAttributes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CompanyAttributes Class Doc Comment * * @category Class * @description List of company attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompanyAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'CompanyAttributes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateContact.php 0000644 00000031470 15021222673 0013511 0 ustar 00 <?php /** * CreateContact * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateContact Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateContact implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createContact'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'extId' => 'string', 'attributes' => 'object', 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'listIds' => 'int[]', 'updateEnabled' => 'bool', 'smtpBlacklistSender' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'extId' => null, 'attributes' => null, 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'listIds' => 'int64', 'updateEnabled' => null, 'smtpBlacklistSender' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'extId' => 'ext_id', 'attributes' => 'attributes', 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'listIds' => 'listIds', 'updateEnabled' => 'updateEnabled', 'smtpBlacklistSender' => 'smtpBlacklistSender' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'extId' => 'setExtId', 'attributes' => 'setAttributes', 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'listIds' => 'setListIds', 'updateEnabled' => 'setUpdateEnabled', 'smtpBlacklistSender' => 'setSmtpBlacklistSender' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'extId' => 'getExtId', 'attributes' => 'getAttributes', 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'listIds' => 'getListIds', 'updateEnabled' => 'getUpdateEnabled', 'smtpBlacklistSender' => 'getSmtpBlacklistSender' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['extId'] = isset($data['extId']) ? $data['extId'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; $this->container['emailBlacklisted'] = isset($data['emailBlacklisted']) ? $data['emailBlacklisted'] : null; $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : false; $this->container['smtpBlacklistSender'] = isset($data['smtpBlacklistSender']) ? $data['smtpBlacklistSender'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets extId * * @return string */ public function getExtId() { return $this->container['extId']; } /** * Sets extId * * @param string $extId Pass your own Id to create a contact. * * @return $this */ public function setExtId($extId) { $this->container['extId'] = $extId; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Gets emailBlacklisted * * @return bool */ public function getEmailBlacklisted() { return $this->container['emailBlacklisted']; } /** * Sets emailBlacklisted * * @param bool $emailBlacklisted Set this field to blacklist the contact for emails (emailBlacklisted = true) * * @return $this */ public function setEmailBlacklisted($emailBlacklisted) { $this->container['emailBlacklisted'] = $emailBlacklisted; return $this; } /** * Gets smsBlacklisted * * @return bool */ public function getSmsBlacklisted() { return $this->container['smsBlacklisted']; } /** * Sets smsBlacklisted * * @param bool $smsBlacklisted Set this field to blacklist the contact for SMS (smsBlacklisted = true) * * @return $this */ public function setSmsBlacklisted($smsBlacklisted) { $this->container['smsBlacklisted'] = $smsBlacklisted; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Ids of the lists to add the contact to * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets updateEnabled * * @return bool */ public function getUpdateEnabled() { return $this->container['updateEnabled']; } /** * Sets updateEnabled * * @param bool $updateEnabled Facilitate to update the existing contact in the same request (updateEnabled = true) * * @return $this */ public function setUpdateEnabled($updateEnabled) { $this->container['updateEnabled'] = $updateEnabled; return $this; } /** * Gets smtpBlacklistSender * * @return string[] */ public function getSmtpBlacklistSender() { return $this->container['smtpBlacklistSender']; } /** * Sets smtpBlacklistSender * * @param string[] $smtpBlacklistSender transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) * * @return $this */ public function setSmtpBlacklistSender($smtpBlacklistSender) { $this->container['smtpBlacklistSender'] = $smtpBlacklistSender; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponseBillingInfoName.php 0000644 00000017571 15021222673 0020176 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfoName * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponseBillingInfoName Class Doc Comment * * @category Class * @description Billing name of master account holder * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfoName implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse_billingInfo_name'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'givenName' => 'string', 'familyName' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'givenName' => null, 'familyName' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'givenName' => 'givenName', 'familyName' => 'familyName' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'givenName' => 'setGivenName', 'familyName' => 'setFamilyName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'givenName' => 'getGivenName', 'familyName' => 'getFamilyName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['givenName'] = isset($data['givenName']) ? $data['givenName'] : null; $this->container['familyName'] = isset($data['familyName']) ? $data['familyName'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets givenName * * @return string */ public function getGivenName() { return $this->container['givenName']; } /** * Sets givenName * * @param string $givenName First name for billing * * @return $this */ public function setGivenName($givenName) { $this->container['givenName'] = $givenName; return $this; } /** * Gets familyName * * @return string */ public function getFamilyName() { return $this->container['familyName']; } /** * Sets familyName * * @param string $familyName Last name for billing * * @return $this */ public function setFamilyName($familyName) { $this->container['familyName'] = $familyName; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSsoToken.php 0000644 00000016127 15021222673 0013201 0 ustar 00 <?php /** * GetSsoToken * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSsoToken Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSsoToken implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSsoToken'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'token' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'token' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'token' => 'token' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'token' => 'setToken' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'token' => 'getToken' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['token'] = isset($data['token']) ? $data['token'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['token'] === null) { $invalidProperties[] = "'token' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets token * * @return string */ public function getToken() { return $this->container['token']; } /** * Sets token * * @param string $token Session token, it will remain valid for 15 days. * * @return $this */ public function setToken($token) { $this->container['token'] = $token; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsappCampaigns.php 0000644 00000017441 15021222673 0015046 0 ustar 00 <?php /** * GetWhatsappCampaigns * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsappCampaigns Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaigns implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsappCampaigns'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaigns' => '\Brevo\Client\Model\GetWhatsappCampaignsCampaigns[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaigns' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaigns' => 'campaigns', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaigns' => 'setCampaigns', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaigns' => 'getCampaigns', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaigns'] = isset($data['campaigns']) ? $data['campaigns'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaigns * * @return \Brevo\Client\Model\GetWhatsappCampaignsCampaigns[] */ public function getCampaigns() { return $this->container['campaigns']; } /** * Sets campaigns * * @param \Brevo\Client\Model\GetWhatsappCampaignsCampaigns[] $campaigns campaigns * * @return $this */ public function setCampaigns($campaigns) { $this->container['campaigns'] = $campaigns; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of WhatsApp campaigns retrived * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestContactImportNewList.php 0000644 00000017750 15021222673 0016444 0 ustar 00 <?php /** * RequestContactImportNewList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestContactImportNewList Class Doc Comment * * @category Class * @description To create a new list and import the contacts into it, pass the listName and an optional folderId. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImportNewList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestContactImport_newList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'listName' => 'string', 'folderId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'listName' => null, 'folderId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'listName' => 'listName', 'folderId' => 'folderId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'listName' => 'setListName', 'folderId' => 'setFolderId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'listName' => 'getListName', 'folderId' => 'getFolderId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['listName'] = isset($data['listName']) ? $data['listName'] : null; $this->container['folderId'] = isset($data['folderId']) ? $data['folderId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets listName * * @return string */ public function getListName() { return $this->container['listName']; } /** * Sets listName * * @param string $listName List with listName will be created first and users will be imported in it (Mandatory if listIds is empty). * * @return $this */ public function setListName($listName) { $this->container['listName'] = $listName; return $this; } /** * Gets folderId * * @return int */ public function getFolderId() { return $this->container['folderId']; } /** * Sets folderId * * @param int $folderId Id of the folder where this new list shall be created (Mandatory if listName is not empty). * * @return $this */ public function setFolderId($folderId) { $this->container['folderId'] = $folderId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateBatchContacts.php 0000644 00000016252 15021222673 0014656 0 ustar 00 <?php /** * UpdateBatchContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateBatchContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateBatchContacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'contacts' => '\Brevo\Client\Model\UpdateBatchContactsContacts[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'contacts' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'contacts' => 'contacts' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'contacts' => 'setContacts' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'contacts' => 'getContacts' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['contacts'] = isset($data['contacts']) ? $data['contacts'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets contacts * * @return \Brevo\Client\Model\UpdateBatchContactsContacts[] */ public function getContacts() { return $this->container['contacts']; } /** * Sets contacts * * @param \Brevo\Client\Model\UpdateBatchContactsContacts[] $contacts List of contacts to be updated * * @return $this */ public function setContacts($contacts) { $this->container['contacts'] = $contacts; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmtpTemplateOverview.php 0000644 00000041227 15021222673 0015601 0 ustar 00 <?php /** * GetSmtpTemplateOverview * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmtpTemplateOverview Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplateOverview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmtpTemplateOverview'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'subject' => 'string', 'isActive' => 'bool', 'testSent' => 'bool', 'sender' => '\Brevo\Client\Model\GetSmtpTemplateOverviewSender', 'replyTo' => 'string', 'toField' => 'string', 'tag' => 'string', 'htmlContent' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'doiTemplate' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'subject' => null, 'isActive' => null, 'testSent' => null, 'sender' => null, 'replyTo' => 'email', 'toField' => null, 'tag' => null, 'htmlContent' => null, 'createdAt' => null, 'modifiedAt' => null, 'doiTemplate' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'subject' => 'subject', 'isActive' => 'isActive', 'testSent' => 'testSent', 'sender' => 'sender', 'replyTo' => 'replyTo', 'toField' => 'toField', 'tag' => 'tag', 'htmlContent' => 'htmlContent', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'doiTemplate' => 'doiTemplate' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'subject' => 'setSubject', 'isActive' => 'setIsActive', 'testSent' => 'setTestSent', 'sender' => 'setSender', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'tag' => 'setTag', 'htmlContent' => 'setHtmlContent', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'doiTemplate' => 'setDoiTemplate' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'subject' => 'getSubject', 'isActive' => 'getIsActive', 'testSent' => 'getTestSent', 'sender' => 'getSender', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'tag' => 'getTag', 'htmlContent' => 'getHtmlContent', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'doiTemplate' => 'getDoiTemplate' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['isActive'] = isset($data['isActive']) ? $data['isActive'] : null; $this->container['testSent'] = isset($data['testSent']) ? $data['testSent'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['doiTemplate'] = isset($data['doiTemplate']) ? $data['doiTemplate'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['subject'] === null) { $invalidProperties[] = "'subject' can't be null"; } if ($this->container['isActive'] === null) { $invalidProperties[] = "'isActive' can't be null"; } if ($this->container['testSent'] === null) { $invalidProperties[] = "'testSent' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['replyTo'] === null) { $invalidProperties[] = "'replyTo' can't be null"; } if ($this->container['toField'] === null) { $invalidProperties[] = "'toField' can't be null"; } if ($this->container['tag'] === null) { $invalidProperties[] = "'tag' can't be null"; } if ($this->container['htmlContent'] === null) { $invalidProperties[] = "'htmlContent' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the template * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the template * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the template * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets isActive * * @return bool */ public function getIsActive() { return $this->container['isActive']; } /** * Sets isActive * * @param bool $isActive Status of template (true=active, false=inactive) * * @return $this */ public function setIsActive($isActive) { $this->container['isActive'] = $isActive; return $this; } /** * Gets testSent * * @return bool */ public function getTestSent() { return $this->container['testSent']; } /** * Sets testSent * * @param bool $testSent Status of test sending for the template (true=test email has been sent, false=test email has not been sent) * * @return $this */ public function setTestSent($testSent) { $this->container['testSent'] = $testSent; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\GetSmtpTemplateOverviewSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\GetSmtpTemplateOverviewSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email defined as the \"Reply to\" for the template * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField Customisation of the \"to\" field for the template * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the template * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent HTML content of the template * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets doiTemplate * * @return bool */ public function getDoiTemplate() { return $this->container['doiTemplate']; } /** * Sets doiTemplate * * @param bool $doiTemplate It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. * * @return $this */ public function setDoiTemplate($doiTemplate) { $this->container['doiTemplate'] = $doiTemplate; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetProcesses.php 0000644 00000017362 15021222673 0013404 0 ustar 00 <?php /** * GetProcesses * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetProcesses Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProcesses implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getProcesses'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'processes' => '\Brevo\Client\Model\GetProcess[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'processes' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'processes' => 'processes', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'processes' => 'setProcesses', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'processes' => 'getProcesses', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['processes'] = isset($data['processes']) ? $data['processes'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets processes * * @return \Brevo\Client\Model\GetProcess[] */ public function getProcesses() { return $this->container['processes']; } /** * Sets processes * * @param \Brevo\Client\Model\GetProcess[] $processes List of processes available on your account * * @return $this */ public function setProcesses($processes) { $this->container['processes'] = $processes; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of processes available on your account * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body12.php 0000644 00000023222 15021222673 0012026 0 ustar 00 <?php /** * Body12 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body12 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body12 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_12'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'agentId' => 'string', 'receivedFrom' => 'string', 'agentEmail' => 'string', 'agentName' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'agentId' => null, 'receivedFrom' => null, 'agentEmail' => 'email', 'agentName' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'agentId' => 'agentId', 'receivedFrom' => 'receivedFrom', 'agentEmail' => 'agentEmail', 'agentName' => 'agentName' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'agentId' => 'setAgentId', 'receivedFrom' => 'setReceivedFrom', 'agentEmail' => 'setAgentEmail', 'agentName' => 'setAgentName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'agentId' => 'getAgentId', 'receivedFrom' => 'getReceivedFrom', 'agentEmail' => 'getAgentEmail', 'agentName' => 'getAgentName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['agentId'] = isset($data['agentId']) ? $data['agentId'] : null; $this->container['receivedFrom'] = isset($data['receivedFrom']) ? $data['receivedFrom'] : null; $this->container['agentEmail'] = isset($data['agentEmail']) ? $data['agentEmail'] : null; $this->container['agentName'] = isset($data['agentName']) ? $data['agentName'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets agentId * * @return string */ public function getAgentId() { return $this->container['agentId']; } /** * Sets agentId * * @param string $agentId agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). * * @return $this */ public function setAgentId($agentId) { $this->container['agentId'] = $agentId; return $this; } /** * Gets receivedFrom * * @return string */ public function getReceivedFrom() { return $this->container['receivedFrom']; } /** * Sets receivedFrom * * @param string $receivedFrom mark your messages to distinguish messages created by you from the others. * * @return $this */ public function setReceivedFrom($receivedFrom) { $this->container['receivedFrom'] = $receivedFrom; return $this; } /** * Gets agentEmail * * @return string */ public function getAgentEmail() { return $this->container['agentEmail']; } /** * Sets agentEmail * * @param string $agentEmail agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. * * @return $this */ public function setAgentEmail($agentEmail) { $this->container['agentEmail'] = $agentEmail; return $this; } /** * Gets agentName * * @return string */ public function getAgentName() { return $this->container['agentName']; } /** * Sets agentName * * @param string $agentName agent name. * * @return $this */ public function setAgentName($agentName) { $this->container['agentName'] = $agentName; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SsoTokenRequest.php 0000644 00000025647 15021222673 0014121 0 ustar 00 <?php /** * SsoTokenRequest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SsoTokenRequest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SsoTokenRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'ssoTokenRequest'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'email' => 'string', 'target' => 'string', 'url' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'email' => null, 'target' => null, 'url' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'email' => 'email', 'target' => 'target', 'url' => 'url' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'email' => 'setEmail', 'target' => 'setTarget', 'url' => 'setUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'email' => 'getEmail', 'target' => 'getTarget', 'url' => 'getUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TARGET_AUTOMATION = 'automation'; const TARGET_EMAIL_CAMPAIGN = 'email_campaign'; const TARGET_CONTACTS = 'contacts'; const TARGET_LANDING_PAGES = 'landing_pages'; const TARGET_EMAIL_TRANSACTIONAL = 'email_transactional'; const TARGET_SENDERS = 'senders'; const TARGET_SMS_CAMPAIGN = 'sms_campaign'; const TARGET_SMS_TRANSACTIONAL = 'sms_transactional'; /** * Gets allowable values of the enum * * @return string[] */ public function getTargetAllowableValues() { return [ self::TARGET_AUTOMATION, self::TARGET_EMAIL_CAMPAIGN, self::TARGET_CONTACTS, self::TARGET_LANDING_PAGES, self::TARGET_EMAIL_TRANSACTIONAL, self::TARGET_SENDERS, self::TARGET_SMS_CAMPAIGN, self::TARGET_SMS_TRANSACTIONAL, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['target'] = isset($data['target']) ? $data['target'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } $allowedValues = $this->getTargetAllowableValues(); if (!is_null($this->container['target']) && !in_array($this->container['target'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'target', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the sub-account organization * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email User email of sub-account organization * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets target * * @return string */ public function getTarget() { return $this->container['target']; } /** * Sets target * * @param string $target Set target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Contacts after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login * * @return $this */ public function setTarget($target) { $allowedValues = $this->getTargetAllowableValues(); if (!is_null($target) && !in_array($target, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'target', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['target'] = $target; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url Set the full target URL after login success. The user will land directly on this target URL after login * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacSmsReport.php 0000644 00000016174 15021222673 0014710 0 ustar 00 <?php /** * GetTransacSmsReport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacSmsReport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacSmsReport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacSmsReport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'reports' => '\Brevo\Client\Model\GetTransacSmsReportReports[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'reports' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'reports' => 'reports' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'reports' => 'setReports' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'reports' => 'getReports' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['reports'] = isset($data['reports']) ? $data['reports'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets reports * * @return \Brevo\Client\Model\GetTransacSmsReportReports[] */ public function getReports() { return $this->container['reports']; } /** * Sets reports * * @param \Brevo\Client\Model\GetTransacSmsReportReports[] $reports reports * * @return $this */ public function setReports($reports) { $this->container['reports'] = $reports; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCouponCollection.php 0000644 00000026465 15021222673 0014721 0 ustar 00 <?php /** * GetCouponCollection * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCouponCollection Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCouponCollection implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCouponCollection'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'defaultCoupon' => 'string', 'createdAt' => '\DateTime', 'totalCoupons' => 'int', 'remainingCoupons' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4', 'name' => 'uuidv4', 'defaultCoupon' => null, 'createdAt' => 'date-time', 'totalCoupons' => 'int64', 'remainingCoupons' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'defaultCoupon' => 'defaultCoupon', 'createdAt' => 'createdAt', 'totalCoupons' => 'totalCoupons', 'remainingCoupons' => 'remainingCoupons' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'defaultCoupon' => 'setDefaultCoupon', 'createdAt' => 'setCreatedAt', 'totalCoupons' => 'setTotalCoupons', 'remainingCoupons' => 'setRemainingCoupons' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'defaultCoupon' => 'getDefaultCoupon', 'createdAt' => 'getCreatedAt', 'totalCoupons' => 'getTotalCoupons', 'remainingCoupons' => 'getRemainingCoupons' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['defaultCoupon'] = isset($data['defaultCoupon']) ? $data['defaultCoupon'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['totalCoupons'] = isset($data['totalCoupons']) ? $data['totalCoupons'] : null; $this->container['remainingCoupons'] = isset($data['remainingCoupons']) ? $data['remainingCoupons'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['defaultCoupon'] === null) { $invalidProperties[] = "'defaultCoupon' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['totalCoupons'] === null) { $invalidProperties[] = "'totalCoupons' can't be null"; } if ($this->container['remainingCoupons'] === null) { $invalidProperties[] = "'remainingCoupons' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id The id of the collection * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name The name of the collection * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets defaultCoupon * * @return string */ public function getDefaultCoupon() { return $this->container['defaultCoupon']; } /** * Sets defaultCoupon * * @param string $defaultCoupon The default coupon of the collection * * @return $this */ public function setDefaultCoupon($defaultCoupon) { $this->container['defaultCoupon'] = $defaultCoupon; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Datetime on which the collection was created * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets totalCoupons * * @return int */ public function getTotalCoupons() { return $this->container['totalCoupons']; } /** * Sets totalCoupons * * @param int $totalCoupons Total coupons in the collection * * @return $this */ public function setTotalCoupons($totalCoupons) { $this->container['totalCoupons'] = $totalCoupons; return $this; } /** * Gets remainingCoupons * * @return int */ public function getRemainingCoupons() { return $this->container['remainingCoupons']; } /** * Sets remainingCoupons * * @param int $remainingCoupons Not sent coupons in the collection * * @return $this */ public function setRemainingCoupons($remainingCoupons) { $this->container['remainingCoupons'] = $remainingCoupons; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateReseller.php 0000644 00000017251 15021222673 0013674 0 ustar 00 <?php /** * CreateReseller * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateReseller Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateReseller implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createReseller'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'authKey' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'authKey' => null, 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'authKey' => 'authKey', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'authKey' => 'setAuthKey', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'authKey' => 'getAuthKey', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['authKey'] = isset($data['authKey']) ? $data['authKey'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['authKey'] === null) { $invalidProperties[] = "'authKey' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets authKey * * @return string */ public function getAuthKey() { return $this->container['authKey']; } /** * Sets authKey * * @param string $authKey AuthKey of Reseller child created * * @return $this */ public function setAuthKey($authKey) { $this->container['authKey'] = $authKey; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of Reseller child created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ErrorModel.php 0000644 00000024343 15021222673 0013045 0 ustar 00 <?php /** * ErrorModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ErrorModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ErrorModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'errorModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'code' => 'string', 'message' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'code' => null, 'message' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'code' => 'code', 'message' => 'message' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'code' => 'setCode', 'message' => 'setMessage' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'code' => 'getCode', 'message' => 'getMessage' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CODE_INVALID_PARAMETER = 'invalid_parameter'; const CODE_MISSING_PARAMETER = 'missing_parameter'; const CODE_OUT_OF_RANGE = 'out_of_range'; const CODE_CAMPAIGN_PROCESSING = 'campaign_processing'; const CODE_CAMPAIGN_SENT = 'campaign_sent'; const CODE_DOCUMENT_NOT_FOUND = 'document_not_found'; const CODE_RESELLER_PERMISSION_DENIED = 'reseller_permission_denied'; const CODE_NOT_ENOUGH_CREDITS = 'not_enough_credits'; const CODE_PERMISSION_DENIED = 'permission_denied'; const CODE_DUPLICATE_PARAMETER = 'duplicate_parameter'; const CODE_DUPLICATE_REQUEST = 'duplicate_request'; const CODE_METHOD_NOT_ALLOWED = 'method_not_allowed'; const CODE_UNAUTHORIZED = 'unauthorized'; const CODE_ACCOUNT_UNDER_VALIDATION = 'account_under_validation'; const CODE_NOT_ACCEPTABLE = 'not_acceptable'; const CODE_BAD_REQUEST = 'bad_request'; /** * Gets allowable values of the enum * * @return string[] */ public function getCodeAllowableValues() { return [ self::CODE_INVALID_PARAMETER, self::CODE_MISSING_PARAMETER, self::CODE_OUT_OF_RANGE, self::CODE_CAMPAIGN_PROCESSING, self::CODE_CAMPAIGN_SENT, self::CODE_DOCUMENT_NOT_FOUND, self::CODE_RESELLER_PERMISSION_DENIED, self::CODE_NOT_ENOUGH_CREDITS, self::CODE_PERMISSION_DENIED, self::CODE_DUPLICATE_PARAMETER, self::CODE_DUPLICATE_REQUEST, self::CODE_METHOD_NOT_ALLOWED, self::CODE_UNAUTHORIZED, self::CODE_ACCOUNT_UNDER_VALIDATION, self::CODE_NOT_ACCEPTABLE, self::CODE_BAD_REQUEST, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['code'] = isset($data['code']) ? $data['code'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['code'] === null) { $invalidProperties[] = "'code' can't be null"; } $allowedValues = $this->getCodeAllowableValues(); if (!is_null($this->container['code']) && !in_array($this->container['code'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'code', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['message'] === null) { $invalidProperties[] = "'message' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets code * * @return string */ public function getCode() { return $this->container['code']; } /** * Sets code * * @param string $code Error code displayed in case of a failure * * @return $this */ public function setCode($code) { $allowedValues = $this->getCodeAllowableValues(); if (!in_array($code, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'code', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['code'] = $code; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Readable message associated to the failure * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body4.php 0000644 00000017454 15021222673 0011761 0 ustar 00 <?php /** * Body4 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body4 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body4 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_4'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'attributes' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'attributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'attributes' => 'attributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'attributes' => 'setAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'attributes' => 'getAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of deal * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes Attributes for deal update If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmtpTemplates.php 0000644 00000017400 15021222673 0014231 0 ustar 00 <?php /** * GetSmtpTemplates * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmtpTemplates Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplates implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmtpTemplates'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'templates' => '\Brevo\Client\Model\GetSmtpTemplateOverview[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => 'int64', 'templates' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'templates' => 'templates' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'templates' => 'setTemplates' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'templates' => 'getTemplates' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['templates'] = isset($data['templates']) ? $data['templates'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Count of transactional email templates * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets templates * * @return \Brevo\Client\Model\GetSmtpTemplateOverview[] */ public function getTemplates() { return $this->container['templates']; } /** * Sets templates * * @param \Brevo\Client\Model\GetSmtpTemplateOverview[] $templates templates * * @return $this */ public function setTemplates($templates) { $this->container['templates'] = $templates; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsCampaign.php 0000644 00000036567 15021222673 0013650 0 ustar 00 <?php /** * GetSmsCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'status' => 'string', 'content' => 'string', 'scheduledAt' => 'string', 'sender' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'recipients' => 'object', 'statistics' => 'object' ]; /** @@ -75,14 +65,6 @@ class GetSmsCampaign implements ModelInterface, ArrayAccess * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'status' => null, 'content' => null, 'scheduledAt' => null, 'sender' => null, 'createdAt' => null, 'modifiedAt' => null, 'recipients' => null, 'statistics' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'status' => 'status', 'content' => 'content', 'scheduledAt' => 'scheduledAt', 'sender' => 'sender', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'recipients' => 'recipients', 'statistics' => 'statistics' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'status' => 'setStatus', 'content' => 'setContent', 'scheduledAt' => 'setScheduledAt', 'sender' => 'setSender', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'recipients' => 'setRecipients', 'statistics' => 'setStatistics' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'status' => 'getStatus', 'content' => 'getContent', 'scheduledAt' => 'getScheduledAt', 'sender' => 'getSender', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'recipients' => 'getRecipients', 'statistics' => 'getStatistics' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_DRAFT = 'draft'; const STATUS_SENT = 'sent'; const STATUS_ARCHIVE = 'archive'; const STATUS_QUEUED = 'queued'; const STATUS_SUSPENDED = 'suspended'; const STATUS_IN_PROCESS = 'inProcess'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_DRAFT, self::STATUS_SENT, self::STATUS_ARCHIVE, self::STATUS_QUEUED, self::STATUS_SUSPENDED, self::STATUS_IN_PROCESS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['statistics'] = isset($data['statistics']) ? $data['statistics'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['content'] === null) { $invalidProperties[] = "'content' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } if ($this->container['recipients'] === null) { $invalidProperties[] = "'recipients' can't be null"; } if ($this->container['statistics'] === null) { $invalidProperties[] = "'statistics' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the SMS Campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the SMS Campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the SMS Campaign * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Content of the SMS Campaign * * @return $this */ public function setContent($content) { $this->container['content'] = $content; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Sender of the SMS Campaign * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets recipients * * @return object */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param object $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets statistics * * @return object */ public function getStatistics() { return $this->container['statistics']; } /** * Sets statistics * * @param object $statistics statistics * * @return $this */ public function setStatistics($statistics) { $this->container['statistics'] = $statistics; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestContactExport.php 0000644 00000022437 15021222673 0015143 0 ustar 00 <?php /** * RequestContactExport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestContactExport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactExport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestContactExport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'exportAttributes' => 'string[]', 'customContactFilter' => '\Brevo\Client\Model\RequestContactExportCustomContactFilter', 'notifyUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'exportAttributes' => null, 'customContactFilter' => null, 'notifyUrl' => 'url' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'exportAttributes' => 'exportAttributes', 'customContactFilter' => 'customContactFilter', 'notifyUrl' => 'notifyUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'exportAttributes' => 'setExportAttributes', 'customContactFilter' => 'setCustomContactFilter', 'notifyUrl' => 'setNotifyUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'exportAttributes' => 'getExportAttributes', 'customContactFilter' => 'getCustomContactFilter', 'notifyUrl' => 'getNotifyUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['exportAttributes'] = isset($data['exportAttributes']) ? $data['exportAttributes'] : null; $this->container['customContactFilter'] = isset($data['customContactFilter']) ? $data['customContactFilter'] : null; $this->container['notifyUrl'] = isset($data['notifyUrl']) ? $data['notifyUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['customContactFilter'] === null) { $invalidProperties[] = "'customContactFilter' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets exportAttributes * * @return string[] */ public function getExportAttributes() { return $this->container['exportAttributes']; } /** * Sets exportAttributes * * @param string[] $exportAttributes List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. * * @return $this */ public function setExportAttributes($exportAttributes) { $this->container['exportAttributes'] = $exportAttributes; return $this; } /** * Gets customContactFilter * * @return \Brevo\Client\Model\RequestContactExportCustomContactFilter */ public function getCustomContactFilter() { return $this->container['customContactFilter']; } /** * Sets customContactFilter * * @param \Brevo\Client\Model\RequestContactExportCustomContactFilter $customContactFilter customContactFilter * * @return $this */ public function setCustomContactFilter($customContactFilter) { $this->container['customContactFilter'] = $customContactFilter; return $this; } /** * Gets notifyUrl * * @return string */ public function getNotifyUrl() { return $this->container['notifyUrl']; } /** * Sets notifyUrl * * @param string $notifyUrl Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 * * @return $this */ public function setNotifyUrl($notifyUrl) { $this->container['notifyUrl'] = $notifyUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactCampaignStats.php 0000644 00000034427 15021222673 0015511 0 ustar 00 <?php /** * GetContactCampaignStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactCampaignStats Class Doc Comment * * @category Class * @description Campaign Statistics for the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactCampaignStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'messagesSent' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'hardBounces' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'softBounces' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'complaints' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'unsubscriptions' => '\Brevo\Client\Model\GetContactCampaignStatsUnsubscriptions', 'opened' => '\Brevo\Client\Model\GetContactCampaignStatsOpened[]', 'clicked' => '\Brevo\Client\Model\GetContactCampaignStatsClicked[]', 'transacAttributes' => '\Brevo\Client\Model\GetContactCampaignStatsTransacAttributes[]', 'delivered' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'messagesSent' => null, 'hardBounces' => null, 'softBounces' => null, 'complaints' => null, 'unsubscriptions' => null, 'opened' => null, 'clicked' => null, 'transacAttributes' => null, 'delivered' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'messagesSent' => 'messagesSent', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'complaints' => 'complaints', 'unsubscriptions' => 'unsubscriptions', 'opened' => 'opened', 'clicked' => 'clicked', 'transacAttributes' => 'transacAttributes', 'delivered' => 'delivered' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'messagesSent' => 'setMessagesSent', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'complaints' => 'setComplaints', 'unsubscriptions' => 'setUnsubscriptions', 'opened' => 'setOpened', 'clicked' => 'setClicked', 'transacAttributes' => 'setTransacAttributes', 'delivered' => 'setDelivered' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'messagesSent' => 'getMessagesSent', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'complaints' => 'getComplaints', 'unsubscriptions' => 'getUnsubscriptions', 'opened' => 'getOpened', 'clicked' => 'getClicked', 'transacAttributes' => 'getTransacAttributes', 'delivered' => 'getDelivered' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['messagesSent'] = isset($data['messagesSent']) ? $data['messagesSent'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['complaints'] = isset($data['complaints']) ? $data['complaints'] : null; $this->container['unsubscriptions'] = isset($data['unsubscriptions']) ? $data['unsubscriptions'] : null; $this->container['opened'] = isset($data['opened']) ? $data['opened'] : null; $this->container['clicked'] = isset($data['clicked']) ? $data['clicked'] : null; $this->container['transacAttributes'] = isset($data['transacAttributes']) ? $data['transacAttributes'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets messagesSent * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getMessagesSent() { return $this->container['messagesSent']; } /** * Sets messagesSent * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $messagesSent messagesSent * * @return $this */ public function setMessagesSent($messagesSent) { $this->container['messagesSent'] = $messagesSent; return $this; } /** * Gets hardBounces * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $hardBounces hardBounces * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $softBounces softBounces * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets complaints * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getComplaints() { return $this->container['complaints']; } /** * Sets complaints * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $complaints complaints * * @return $this */ public function setComplaints($complaints) { $this->container['complaints'] = $complaints; return $this; } /** * Gets unsubscriptions * * @return \Brevo\Client\Model\GetContactCampaignStatsUnsubscriptions */ public function getUnsubscriptions() { return $this->container['unsubscriptions']; } /** * Sets unsubscriptions * * @param \Brevo\Client\Model\GetContactCampaignStatsUnsubscriptions $unsubscriptions unsubscriptions * * @return $this */ public function setUnsubscriptions($unsubscriptions) { $this->container['unsubscriptions'] = $unsubscriptions; return $this; } /** * Gets opened * * @return \Brevo\Client\Model\GetContactCampaignStatsOpened[] */ public function getOpened() { return $this->container['opened']; } /** * Sets opened * * @param \Brevo\Client\Model\GetContactCampaignStatsOpened[] $opened opened * * @return $this */ public function setOpened($opened) { $this->container['opened'] = $opened; return $this; } /** * Gets clicked * * @return \Brevo\Client\Model\GetContactCampaignStatsClicked[] */ public function getClicked() { return $this->container['clicked']; } /** * Sets clicked * * @param \Brevo\Client\Model\GetContactCampaignStatsClicked[] $clicked clicked * * @return $this */ public function setClicked($clicked) { $this->container['clicked'] = $clicked; return $this; } /** * Gets transacAttributes * * @return \Brevo\Client\Model\GetContactCampaignStatsTransacAttributes[] */ public function getTransacAttributes() { return $this->container['transacAttributes']; } /** * Sets transacAttributes * * @param \Brevo\Client\Model\GetContactCampaignStatsTransacAttributes[] $transacAttributes transacAttributes * * @return $this */ public function setTransacAttributes($transacAttributes) { $this->container['transacAttributes'] = $transacAttributes; return $this; } /** * Gets delivered * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $delivered delivered * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponseBillingInfo.php 0000644 00000022500 15021222673 0017361 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponseBillingInfo Class Doc Comment * * @category Class * @description Billing details of the master account organization * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse_billingInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'companyName' => 'string', 'name' => '\Brevo\Client\Model\MasterDetailsResponseBillingInfoName', 'address' => '\Brevo\Client\Model\MasterDetailsResponseBillingInfoAddress' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => null, 'companyName' => null, 'name' => null, 'address' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'companyName' => 'companyName', 'name' => 'name', 'address' => 'address' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'companyName' => 'setCompanyName', 'name' => 'setName', 'address' => 'setAddress' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'companyName' => 'getCompanyName', 'name' => 'getName', 'address' => 'getAddress' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['address'] = isset($data['address']) ? $data['address'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Billing email id of master account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Company name of master account * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets name * * @return \Brevo\Client\Model\MasterDetailsResponseBillingInfoName */ public function getName() { return $this->container['name']; } /** * Sets name * * @param \Brevo\Client\Model\MasterDetailsResponseBillingInfoName $name name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets address * * @return \Brevo\Client\Model\MasterDetailsResponseBillingInfoAddress */ public function getAddress() { return $this->container['address']; } /** * Sets address * * @param \Brevo\Client\Model\MasterDetailsResponseBillingInfoAddress $address address * * @return $this */ public function setAddress($address) { $this->container['address'] = $address; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailTo.php 0000644 00000017315 15021222673 0014004 0 ustar 00 <?php /** * SendSmtpEmailTo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailTo Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailTo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_to'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the recipient * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the recipient. Maximum allowed characters are 70. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateAttributeEnumeration.php 0000644 00000017503 15021222673 0016310 0 ustar 00 <?php /** * UpdateAttributeEnumeration * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateAttributeEnumeration Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateAttributeEnumeration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateAttribute_enumeration'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'int', 'label' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => null, 'label' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'label' => 'label' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'label' => 'setLabel' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'label' => 'getLabel' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['label'] = isset($data['label']) ? $data['label'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } if ($this->container['label'] === null) { $invalidProperties[] = "'label' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return int */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param int $value Id of the value * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets label * * @return string */ public function getLabel() { return $this->container['label']; } /** * Sets label * * @param string $label Label of the value * * @return $this */ public function setLabel($label) { $this->container['label'] = $label; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacBlockedContactsReason.php 0000644 00000022404 15021222673 0017155 0 ustar 00 <?php /** * GetTransacBlockedContactsReason * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacBlockedContactsReason Class Doc Comment * * @category Class * @description Reason for blocking / unsubscribing * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContactsReason implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacBlockedContacts_reason'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'code' => 'string', 'message' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'code' => null, 'message' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'code' => 'code', 'message' => 'message' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'code' => 'setCode', 'message' => 'setMessage' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'code' => 'getCode', 'message' => 'getMessage' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CODE_UNSUBSCRIBED_VIA_MA = 'unsubscribedViaMA'; const CODE_UNSUBSCRIBED_VIA_EMAIL = 'unsubscribedViaEmail'; const CODE_ADMIN_BLOCKED = 'adminBlocked'; const CODE_UNSUBSCRIBED_VIA_API = 'unsubscribedViaApi'; const CODE_HARD_BOUNCE = 'hardBounce'; const CODE_CONTACT_FLAGGED_AS_SPAM = 'contactFlaggedAsSpam'; /** * Gets allowable values of the enum * * @return string[] */ public function getCodeAllowableValues() { return [ self::CODE_UNSUBSCRIBED_VIA_MA, self::CODE_UNSUBSCRIBED_VIA_EMAIL, self::CODE_ADMIN_BLOCKED, self::CODE_UNSUBSCRIBED_VIA_API, self::CODE_HARD_BOUNCE, self::CODE_CONTACT_FLAGGED_AS_SPAM, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['code'] = isset($data['code']) ? $data['code'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getCodeAllowableValues(); if (!is_null($this->container['code']) && !in_array($this->container['code'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'code', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets code * * @return string */ public function getCode() { return $this->container['code']; } /** * Sets code * * @param string $code Reason code for blocking / unsubscribing (This code is safe for comparison) * * @return $this */ public function setCode($code) { $allowedValues = $this->getCodeAllowableValues(); if (!is_null($code) && !in_array($code, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'code', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['code'] = $code; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Reason for blocking / unsubscribing (This string is not safe for comparison) * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/NoteId.php 0000644 00000015615 15021222673 0012157 0 ustar 00 <?php /** * NoteId * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * NoteId Class Doc Comment * * @category Class * @description Updated Note ID * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'NoteId'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique note Id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSendersListSenders.php 0000644 00000023711 15021222673 0015214 0 ustar 00 <?php /** * GetSendersListSenders * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSendersListSenders Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersListSenders implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSendersList_senders'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'email' => 'string', 'active' => 'bool', 'ips' => '\Brevo\Client\Model\GetSendersListIps[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'email' => null, 'active' => null, 'ips' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'email' => 'email', 'active' => 'active', 'ips' => 'ips' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'email' => 'setEmail', 'active' => 'setActive', 'ips' => 'setIps' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'email' => 'getEmail', 'active' => 'getActive', 'ips' => 'getIps' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['active'] = isset($data['active']) ? $data['active'] : null; $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['active'] === null) { $invalidProperties[] = "'active' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the sender * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name From Name associated to the sender * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email From Email associated to the sender * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets active * * @return bool */ public function getActive() { return $this->container['active']; } /** * Sets active * * @param bool $active Status of sender (true=activated, false=deactivated) * * @return $this */ public function setActive($active) { $this->container['active'] = $active; return $this; } /** * Gets ips * * @return \Brevo\Client\Model\GetSendersListIps[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param \Brevo\Client\Model\GetSendersListIps[] $ips List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetIpFromSender.php 0000644 00000022165 15021222673 0013770 0 ustar 00 <?php /** * GetIpFromSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetIpFromSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpFromSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getIpFromSender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'ip' => 'string', 'domain' => 'string', 'weight' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'ip' => null, 'domain' => null, 'weight' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'ip' => 'ip', 'domain' => 'domain', 'weight' => 'weight' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'ip' => 'setIp', 'domain' => 'setDomain', 'weight' => 'setWeight' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'ip' => 'getIp', 'domain' => 'getDomain', 'weight' => 'getWeight' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; $this->container['weight'] = isset($data['weight']) ? $data['weight'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } if ($this->container['weight'] === null) { $invalidProperties[] = "'weight' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the dedicated IP * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated IP * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Domain associated to the IP * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Gets weight * * @return int */ public function getWeight() { return $this->container['weight']; } /** * Sets weight * * @param int $weight Weight of the IP * * @return $this */ public function setWeight($weight) { $this->container['weight'] = $weight; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateContactModel.php 0000644 00000015720 15021222673 0015635 0 ustar 00 <?php /** * CreateUpdateContactModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateContactModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateContactModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateContactModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the contact when a new contact is created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/TaskTypes.php 0000644 00000016776 15021222673 0012735 0 ustar 00 <?php /** * TaskTypes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * TaskTypes Class Doc Comment * * @category Class * @description Task types details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskTypes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'TaskTypes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'title' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'title' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'title' => 'title' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'title' => 'setTitle' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'title' => 'getTitle' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['title'] = isset($data['title']) ? $data['title'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Id of task type * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets title * * @return string */ public function getTitle() { return $this->container['title']; } /** * Sets title * * @param string $title Title of task type * * @return $this */ public function setTitle($title) { $this->container['title'] = $title; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfo.php 0000644 00000021325 15021222673 0017512 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfo Class Doc Comment * * @category Class * @description Sub-account plan details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'credits' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCredits', 'features' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeatures', 'planType' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'credits' => null, 'features' => null, 'planType' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'credits' => 'credits', 'features' => 'features', 'planType' => 'planType' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'credits' => 'setCredits', 'features' => 'setFeatures', 'planType' => 'setPlanType' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'credits' => 'getCredits', 'features' => 'getFeatures', 'planType' => 'getPlanType' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['credits'] = isset($data['credits']) ? $data['credits'] : null; $this->container['features'] = isset($data['features']) ? $data['features'] : null; $this->container['planType'] = isset($data['planType']) ? $data['planType'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets credits * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCredits */ public function getCredits() { return $this->container['credits']; } /** * Sets credits * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoCredits $credits credits * * @return $this */ public function setCredits($credits) { $this->container['credits'] = $credits; return $this; } /** * Gets features * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeatures */ public function getFeatures() { return $this->container['features']; } /** * Sets features * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeatures $features features * * @return $this */ public function setFeatures($features) { $this->container['features'] = $features; return $this; } /** * Gets planType * * @return string */ public function getPlanType() { return $this->container['planType']; } /** * Sets planType * * @param string $planType type of the plan * * @return $this */ public function setPlanType($planType) { $this->container['planType'] = $planType; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountsResponse.php 0000644 00000017475 15021222673 0014753 0 ustar 00 <?php /** * SubAccountsResponse * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountsResponse Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountsResponse'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'subAccounts' => '\Brevo\Client\Model\SubAccountsResponseSubAccounts[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => null, 'subAccounts' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'subAccounts' => 'subAccounts' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'subAccounts' => 'setSubAccounts' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'subAccounts' => 'getSubAccounts' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['subAccounts'] = isset($data['subAccounts']) ? $data['subAccounts'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Total number of subaccounts * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets subAccounts * * @return \Brevo\Client\Model\SubAccountsResponseSubAccounts[] */ public function getSubAccounts() { return $this->container['subAccounts']; } /** * Sets subAccounts * * @param \Brevo\Client\Model\SubAccountsResponseSubAccounts[] $subAccounts subAccounts * * @return $this */ public function setSubAccounts($subAccounts) { $this->container['subAccounts'] = $subAccounts; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.php 0000644 00000017536 15021222673 0022222 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesInbox * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoFeaturesInbox Class Doc Comment * * @category Class * @description Inbox details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesInbox implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_features_inbox'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'quantity' => 'int', 'remaining' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'quantity' => 'int64', 'remaining' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'quantity' => 'quantity', 'remaining' => 'remaining' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'quantity' => 'setQuantity', 'remaining' => 'setRemaining' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'quantity' => 'getQuantity', 'remaining' => 'getRemaining' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets quantity * * @return int */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param int $quantity Quantity of inbox provided * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Available inboxes for use * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfoCredits.php 0000644 00000017576 15021222673 0014622 0 ustar 00 <?php /** * GetChildInfoCredits * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildInfoCredits Class Doc Comment * * @category Class * @description Credits available for your child * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoCredits implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo_credits'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'emailCredits' => 'int', 'smsCredits' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'emailCredits' => 'int64', 'smsCredits' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'emailCredits' => 'emailCredits', 'smsCredits' => 'smsCredits' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'emailCredits' => 'setEmailCredits', 'smsCredits' => 'setSmsCredits' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'emailCredits' => 'getEmailCredits', 'smsCredits' => 'getSmsCredits' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['emailCredits'] = isset($data['emailCredits']) ? $data['emailCredits'] : null; $this->container['smsCredits'] = isset($data['smsCredits']) ? $data['smsCredits'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets emailCredits * * @return int */ public function getEmailCredits() { return $this->container['emailCredits']; } /** * Sets emailCredits * * @param int $emailCredits Email credits available for your child * * @return $this */ public function setEmailCredits($emailCredits) { $this->container['emailCredits'] = $emailCredits; return $this; } /** * Gets smsCredits * * @return int */ public function getSmsCredits() { return $this->container['smsCredits']; } /** * Sets smsCredits * * @param int $smsCredits SMS credits available for your child * * @return $this */ public function setSmsCredits($smsCredits) { $this->container['smsCredits'] = $smsCredits; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateCouponCollection.php 0000644 00000020052 15021222673 0015367 0 ustar 00 <?php /** * CreateCouponCollection * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateCouponCollection Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCouponCollection implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createCouponCollection'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'object', 'defaultCoupon' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'defaultCoupon' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'defaultCoupon' => 'defaultCoupon' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'defaultCoupon' => 'setDefaultCoupon' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'defaultCoupon' => 'getDefaultCoupon' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['defaultCoupon'] = isset($data['defaultCoupon']) ? $data['defaultCoupon'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['defaultCoupon'] === null) { $invalidProperties[] = "'defaultCoupon' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return object */ public function getName() { return $this->container['name']; } /** * Sets name * * @param object $name Name of the collection with no white spaces between words * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets defaultCoupon * * @return object */ public function getDefaultCoupon() { return $this->container['defaultCoupon']; } /** * Sets defaultCoupon * * @param object $defaultCoupon A default coupon to be used in case there are no coupons left * * @return $this */ public function setDefaultCoupon($defaultCoupon) { $this->container['defaultCoupon'] = $defaultCoupon; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/PostSendSmsTestFailed.php 0000644 00000022542 15021222673 0015161 0 ustar 00 <?php /** * PostSendSmsTestFailed * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * PostSendSmsTestFailed Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostSendSmsTestFailed implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'postSendSmsTestFailed'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'code' => 'int', 'message' => 'string', 'unexistingSms' => 'string[]', 'withoutListSms' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'code' => 'int64', 'message' => null, 'unexistingSms' => 'email', 'withoutListSms' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'code' => 'code', 'message' => 'message', 'unexistingSms' => 'unexistingSms', 'withoutListSms' => 'withoutListSms' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'code' => 'setCode', 'message' => 'setMessage', 'unexistingSms' => 'setUnexistingSms', 'withoutListSms' => 'setWithoutListSms' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'code' => 'getCode', 'message' => 'getMessage', 'unexistingSms' => 'getUnexistingSms', 'withoutListSms' => 'getWithoutListSms' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['code'] = isset($data['code']) ? $data['code'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; $this->container['unexistingSms'] = isset($data['unexistingSms']) ? $data['unexistingSms'] : null; $this->container['withoutListSms'] = isset($data['withoutListSms']) ? $data['withoutListSms'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['code'] === null) { $invalidProperties[] = "'code' can't be null"; } if ($this->container['message'] === null) { $invalidProperties[] = "'message' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets code * * @return int */ public function getCode() { return $this->container['code']; } /** * Sets code * * @param int $code Response code * * @return $this */ public function setCode($code) { $this->container['code'] = $code; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Response message * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Gets unexistingSms * * @return string[] */ public function getUnexistingSms() { return $this->container['unexistingSms']; } /** * Sets unexistingSms * * @param string[] $unexistingSms unexistingSms * * @return $this */ public function setUnexistingSms($unexistingSms) { $this->container['unexistingSms'] = $unexistingSms; return $this; } /** * Gets withoutListSms * * @return string[] */ public function getWithoutListSms() { return $this->container['withoutListSms']; } /** * Sets withoutListSms * * @param string[] $withoutListSms withoutListSms * * @return $this */ public function setWithoutListSms($withoutListSms) { $this->container['withoutListSms'] = $withoutListSms; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetReports.php 0000644 00000016075 15021222673 0013074 0 ustar 00 <?php /** * GetReports * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetReports Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetReports implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getReports'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'reports' => '\Brevo\Client\Model\GetReportsReports[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'reports' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'reports' => 'reports' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'reports' => 'setReports' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'reports' => 'getReports' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['reports'] = isset($data['reports']) ? $data['reports'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets reports * * @return \Brevo\Client\Model\GetReportsReports[] */ public function getReports() { return $this->container['reports']; } /** * Sets reports * * @param \Brevo\Client\Model\GetReportsReports[] $reports reports * * @return $this */ public function setReports($reports) { $this->container['reports'] = $reports; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateWhatsAppCampaign.php 0000644 00000023567 15021222673 0015315 0 ustar 00 <?php /** * CreateWhatsAppCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateWhatsAppCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createWhatsAppCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'templateId' => 'int', 'scheduledAt' => 'string', 'recipients' => '\Brevo\Client\Model\CreateWhatsAppCampaignRecipients' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'templateId' => null, 'scheduledAt' => null, 'recipients' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'templateId' => 'templateId', 'scheduledAt' => 'scheduledAt', 'recipients' => 'recipients' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'templateId' => 'setTemplateId', 'scheduledAt' => 'setScheduledAt', 'recipients' => 'setRecipients' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'templateId' => 'getTemplateId', 'scheduledAt' => 'getScheduledAt', 'recipients' => 'getRecipients' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['templateId'] === null) { $invalidProperties[] = "'templateId' can't be null"; } if ($this->container['scheduledAt'] === null) { $invalidProperties[] = "'scheduledAt' can't be null"; } if ($this->container['recipients'] === null) { $invalidProperties[] = "'recipients' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the WhatsApp campaign creation * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Id of the WhatsApp template in **approved** state * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\CreateWhatsAppCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\CreateWhatsAppCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsCampaigns.php 0000644 00000017210 15021222673 0014013 0 ustar 00 <?php /** * GetSmsCampaigns * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsCampaigns Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaigns implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsCampaigns'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaigns' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaigns' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaigns' => 'campaigns', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaigns' => 'setCampaigns', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaigns' => 'getCampaigns', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaigns'] = isset($data['campaigns']) ? $data['campaigns'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaigns * * @return object[] */ public function getCampaigns() { return $this->container['campaigns']; } /** * Sets campaigns * * @param object[] $campaigns campaigns * * @return $this */ public function setCampaigns($campaigns) { $this->container['campaigns'] = $campaigns; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of SMS campaigns retrieved * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailReplyTo.php 0000644 00000017704 15021222673 0015022 0 ustar 00 <?php /** * SendSmtpEmailReplyTo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailReplyTo Class Doc Comment * * @category Class * @description Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailReplyTo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_replyTo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address in reply to * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name in reply to. Maximum allowed characters are 70. * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetDomainsListDomains.php 0000644 00000024221 15021222673 0015167 0 ustar 00 <?php /** * GetDomainsListDomains * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetDomainsListDomains Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainsListDomains implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getDomainsList_domains'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'domainName' => 'string', 'authenticated' => 'bool', 'verified' => 'bool', 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'domainName' => null, 'authenticated' => null, 'verified' => null, 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'domainName' => 'domain_name', 'authenticated' => 'authenticated', 'verified' => 'verified', 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'domainName' => 'setDomainName', 'authenticated' => 'setAuthenticated', 'verified' => 'setVerified', 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'domainName' => 'getDomainName', 'authenticated' => 'getAuthenticated', 'verified' => 'getVerified', 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['domainName'] = isset($data['domainName']) ? $data['domainName'] : null; $this->container['authenticated'] = isset($data['authenticated']) ? $data['authenticated'] : null; $this->container['verified'] = isset($data['verified']) ? $data['verified'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['domainName'] === null) { $invalidProperties[] = "'domainName' can't be null"; } if ($this->container['authenticated'] === null) { $invalidProperties[] = "'authenticated' can't be null"; } if ($this->container['verified'] === null) { $invalidProperties[] = "'verified' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the domain * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets domainName * * @return string */ public function getDomainName() { return $this->container['domainName']; } /** * Sets domainName * * @param string $domainName Domain name * * @return $this */ public function setDomainName($domainName) { $this->container['domainName'] = $domainName; return $this; } /** * Gets authenticated * * @return bool */ public function getAuthenticated() { return $this->container['authenticated']; } /** * Sets authenticated * * @param bool $authenticated Status of domain authentication (true=authenticated, false=non authenticated) * * @return $this */ public function setAuthenticated($authenticated) { $this->container['authenticated'] = $authenticated; return $this; } /** * Gets verified * * @return bool */ public function getVerified() { return $this->container['verified']; } /** * Sets verified * * @param bool $verified Status of domain verification (true=verified, false=non verified) * * @return $this */ public function setVerified($verified) { $this->container['verified'] = $verified; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated IP associated with domain * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/EmailExportRecipients.php 0000644 00000023443 15021222673 0015252 0 ustar 00 <?php /** * EmailExportRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * EmailExportRecipients Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EmailExportRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'emailExportRecipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'notifyURL' => 'string', 'recipientsType' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'notifyURL' => 'url', 'recipientsType' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'notifyURL' => 'notifyURL', 'recipientsType' => 'recipientsType' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'notifyURL' => 'setNotifyURL', 'recipientsType' => 'setRecipientsType' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'notifyURL' => 'getNotifyURL', 'recipientsType' => 'getRecipientsType' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const RECIPIENTS_TYPE_ALL = 'all'; const RECIPIENTS_TYPE_NON_CLICKERS = 'nonClickers'; const RECIPIENTS_TYPE_NON_OPENERS = 'nonOpeners'; const RECIPIENTS_TYPE_CLICKERS = 'clickers'; const RECIPIENTS_TYPE_OPENERS = 'openers'; const RECIPIENTS_TYPE_SOFT_BOUNCES = 'softBounces'; const RECIPIENTS_TYPE_HARD_BOUNCES = 'hardBounces'; const RECIPIENTS_TYPE_UNSUBSCRIBED = 'unsubscribed'; /** * Gets allowable values of the enum * * @return string[] */ public function getRecipientsTypeAllowableValues() { return [ self::RECIPIENTS_TYPE_ALL, self::RECIPIENTS_TYPE_NON_CLICKERS, self::RECIPIENTS_TYPE_NON_OPENERS, self::RECIPIENTS_TYPE_CLICKERS, self::RECIPIENTS_TYPE_OPENERS, self::RECIPIENTS_TYPE_SOFT_BOUNCES, self::RECIPIENTS_TYPE_HARD_BOUNCES, self::RECIPIENTS_TYPE_UNSUBSCRIBED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['notifyURL'] = isset($data['notifyURL']) ? $data['notifyURL'] : null; $this->container['recipientsType'] = isset($data['recipientsType']) ? $data['recipientsType'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['recipientsType'] === null) { $invalidProperties[] = "'recipientsType' can't be null"; } $allowedValues = $this->getRecipientsTypeAllowableValues(); if (!is_null($this->container['recipientsType']) && !in_array($this->container['recipientsType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'recipientsType', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets notifyURL * * @return string */ public function getNotifyURL() { return $this->container['notifyURL']; } /** * Sets notifyURL * * @param string $notifyURL Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 * * @return $this */ public function setNotifyURL($notifyURL) { $this->container['notifyURL'] = $notifyURL; return $this; } /** * Gets recipientsType * * @return string */ public function getRecipientsType() { return $this->container['recipientsType']; } /** * Sets recipientsType * * @param string $recipientsType Type of recipients to export for a campaign * * @return $this */ public function setRecipientsType($recipientsType) { $allowedValues = $this->getRecipientsTypeAllowableValues(); if (!in_array($recipientsType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'recipientsType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['recipientsType'] = $recipientsType; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateEmailCampaign.php 0000644 00000107534 15021222673 0014612 0 ustar 00 <?php /** * CreateEmailCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateEmailCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createEmailCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'tag' => 'string', 'sender' => '\Brevo\Client\Model\CreateEmailCampaignSender', 'name' => 'string', 'htmlContent' => 'string', 'htmlUrl' => 'string', 'templateId' => 'int', 'scheduledAt' => 'string', 'subject' => 'string', 'previewText' => 'string', 'replyTo' => 'string', 'toField' => 'string', 'recipients' => '\Brevo\Client\Model\CreateEmailCampaignRecipients', 'attachmentUrl' => 'string', 'inlineImageActivation' => 'bool', 'mirrorActive' => 'bool', 'footer' => 'string', 'header' => 'string', 'utmCampaign' => 'string', 'params' => 'object', 'sendAtBestTime' => 'bool', 'abTesting' => 'bool', 'subjectA' => 'string', 'subjectB' => 'string', 'splitRule' => 'int', 'winnerCriteria' => 'string', 'winnerDelay' => 'int', 'ipWarmupEnable' => 'bool', 'initialQuota' => 'int', 'increaseRate' => 'int', 'unsubscriptionPageId' => 'string', 'updateFormId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'tag' => null, 'sender' => null, 'name' => null, 'htmlContent' => null, 'htmlUrl' => 'url', 'templateId' => 'int64', 'scheduledAt' => null, 'subject' => null, 'previewText' => null, 'replyTo' => 'email', 'toField' => null, 'recipients' => null, 'attachmentUrl' => 'url', 'inlineImageActivation' => null, 'mirrorActive' => null, 'footer' => null, 'header' => null, 'utmCampaign' => null, 'params' => null, 'sendAtBestTime' => null, 'abTesting' => null, 'subjectA' => null, 'subjectB' => null, 'splitRule' => 'int64', 'winnerCriteria' => null, 'winnerDelay' => 'int64', 'ipWarmupEnable' => null, 'initialQuota' => 'int64', 'increaseRate' => 'int64', 'unsubscriptionPageId' => null, 'updateFormId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'tag' => 'tag', 'sender' => 'sender', 'name' => 'name', 'htmlContent' => 'htmlContent', 'htmlUrl' => 'htmlUrl', 'templateId' => 'templateId', 'scheduledAt' => 'scheduledAt', 'subject' => 'subject', 'previewText' => 'previewText', 'replyTo' => 'replyTo', 'toField' => 'toField', 'recipients' => 'recipients', 'attachmentUrl' => 'attachmentUrl', 'inlineImageActivation' => 'inlineImageActivation', 'mirrorActive' => 'mirrorActive', 'footer' => 'footer', 'header' => 'header', 'utmCampaign' => 'utmCampaign', 'params' => 'params', 'sendAtBestTime' => 'sendAtBestTime', 'abTesting' => 'abTesting', 'subjectA' => 'subjectA', 'subjectB' => 'subjectB', 'splitRule' => 'splitRule', 'winnerCriteria' => 'winnerCriteria', 'winnerDelay' => 'winnerDelay', 'ipWarmupEnable' => 'ipWarmupEnable', 'initialQuota' => 'initialQuota', 'increaseRate' => 'increaseRate', 'unsubscriptionPageId' => 'unsubscriptionPageId', 'updateFormId' => 'updateFormId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'tag' => 'setTag', 'sender' => 'setSender', 'name' => 'setName', 'htmlContent' => 'setHtmlContent', 'htmlUrl' => 'setHtmlUrl', 'templateId' => 'setTemplateId', 'scheduledAt' => 'setScheduledAt', 'subject' => 'setSubject', 'previewText' => 'setPreviewText', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'recipients' => 'setRecipients', 'attachmentUrl' => 'setAttachmentUrl', 'inlineImageActivation' => 'setInlineImageActivation', 'mirrorActive' => 'setMirrorActive', 'footer' => 'setFooter', 'header' => 'setHeader', 'utmCampaign' => 'setUtmCampaign', 'params' => 'setParams', 'sendAtBestTime' => 'setSendAtBestTime', 'abTesting' => 'setAbTesting', 'subjectA' => 'setSubjectA', 'subjectB' => 'setSubjectB', 'splitRule' => 'setSplitRule', 'winnerCriteria' => 'setWinnerCriteria', 'winnerDelay' => 'setWinnerDelay', 'ipWarmupEnable' => 'setIpWarmupEnable', 'initialQuota' => 'setInitialQuota', 'increaseRate' => 'setIncreaseRate', 'unsubscriptionPageId' => 'setUnsubscriptionPageId', 'updateFormId' => 'setUpdateFormId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'tag' => 'getTag', 'sender' => 'getSender', 'name' => 'getName', 'htmlContent' => 'getHtmlContent', 'htmlUrl' => 'getHtmlUrl', 'templateId' => 'getTemplateId', 'scheduledAt' => 'getScheduledAt', 'subject' => 'getSubject', 'previewText' => 'getPreviewText', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'recipients' => 'getRecipients', 'attachmentUrl' => 'getAttachmentUrl', 'inlineImageActivation' => 'getInlineImageActivation', 'mirrorActive' => 'getMirrorActive', 'footer' => 'getFooter', 'header' => 'getHeader', 'utmCampaign' => 'getUtmCampaign', 'params' => 'getParams', 'sendAtBestTime' => 'getSendAtBestTime', 'abTesting' => 'getAbTesting', 'subjectA' => 'getSubjectA', 'subjectB' => 'getSubjectB', 'splitRule' => 'getSplitRule', 'winnerCriteria' => 'getWinnerCriteria', 'winnerDelay' => 'getWinnerDelay', 'ipWarmupEnable' => 'getIpWarmupEnable', 'initialQuota' => 'getInitialQuota', 'increaseRate' => 'getIncreaseRate', 'unsubscriptionPageId' => 'getUnsubscriptionPageId', 'updateFormId' => 'getUpdateFormId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const WINNER_CRITERIA_OPEN = 'open'; const WINNER_CRITERIA_CLICK = 'click'; /** * Gets allowable values of the enum * * @return string[] */ public function getWinnerCriteriaAllowableValues() { return [ self::WINNER_CRITERIA_OPEN, self::WINNER_CRITERIA_CLICK, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['htmlUrl'] = isset($data['htmlUrl']) ? $data['htmlUrl'] : null; $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['previewText'] = isset($data['previewText']) ? $data['previewText'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['attachmentUrl'] = isset($data['attachmentUrl']) ? $data['attachmentUrl'] : null; $this->container['inlineImageActivation'] = isset($data['inlineImageActivation']) ? $data['inlineImageActivation'] : false; $this->container['mirrorActive'] = isset($data['mirrorActive']) ? $data['mirrorActive'] : null; $this->container['footer'] = isset($data['footer']) ? $data['footer'] : null; $this->container['header'] = isset($data['header']) ? $data['header'] : null; $this->container['utmCampaign'] = isset($data['utmCampaign']) ? $data['utmCampaign'] : null; $this->container['params'] = isset($data['params']) ? $data['params'] : null; $this->container['sendAtBestTime'] = isset($data['sendAtBestTime']) ? $data['sendAtBestTime'] : false; $this->container['abTesting'] = isset($data['abTesting']) ? $data['abTesting'] : false; $this->container['subjectA'] = isset($data['subjectA']) ? $data['subjectA'] : null; $this->container['subjectB'] = isset($data['subjectB']) ? $data['subjectB'] : null; $this->container['splitRule'] = isset($data['splitRule']) ? $data['splitRule'] : null; $this->container['winnerCriteria'] = isset($data['winnerCriteria']) ? $data['winnerCriteria'] : null; $this->container['winnerDelay'] = isset($data['winnerDelay']) ? $data['winnerDelay'] : null; $this->container['ipWarmupEnable'] = isset($data['ipWarmupEnable']) ? $data['ipWarmupEnable'] : false; $this->container['initialQuota'] = isset($data['initialQuota']) ? $data['initialQuota'] : null; $this->container['increaseRate'] = isset($data['increaseRate']) ? $data['increaseRate'] : null; $this->container['unsubscriptionPageId'] = isset($data['unsubscriptionPageId']) ? $data['unsubscriptionPageId'] : null; $this->container['updateFormId'] = isset($data['updateFormId']) ? $data['updateFormId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if (!is_null($this->container['splitRule']) && ($this->container['splitRule'] > 50)) { $invalidProperties[] = "invalid value for 'splitRule', must be smaller than or equal to 50."; } if (!is_null($this->container['splitRule']) && ($this->container['splitRule'] < 1)) { $invalidProperties[] = "invalid value for 'splitRule', must be bigger than or equal to 1."; } $allowedValues = $this->getWinnerCriteriaAllowableValues(); if (!is_null($this->container['winnerCriteria']) && !in_array($this->container['winnerCriteria'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'winnerCriteria', must be one of '%s'", implode("', '", $allowedValues) ); } if (!is_null($this->container['winnerDelay']) && ($this->container['winnerDelay'] > 168)) { $invalidProperties[] = "invalid value for 'winnerDelay', must be smaller than or equal to 168."; } if (!is_null($this->container['winnerDelay']) && ($this->container['winnerDelay'] < 1)) { $invalidProperties[] = "invalid value for 'winnerDelay', must be bigger than or equal to 1."; } if (!is_null($this->container['increaseRate']) && ($this->container['increaseRate'] > 100)) { $invalidProperties[] = "invalid value for 'increaseRate', must be smaller than or equal to 100."; } if (!is_null($this->container['increaseRate']) && ($this->container['increaseRate'] < 0)) { $invalidProperties[] = "invalid value for 'increaseRate', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the campaign * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\CreateEmailCampaignSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\CreateEmailCampaignSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets htmlUrl * * @return string */ public function getHtmlUrl() { return $this->container['htmlUrl']; } /** * Sets htmlUrl * * @param string $htmlUrl Mandatory if htmlContent and templateId are empty. Url to the message (HTML) * * @return $this */ public function setHtmlUrl($htmlUrl) { $this->container['htmlUrl'] = $htmlUrl; return $this; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets previewText * * @return string */ public function getPreviewText() { return $this->container['previewText']; } /** * Sets previewText * * @param string $previewText Preview text or preheader of the email campaign * * @return $this */ public function setPreviewText($previewText) { $this->container['previewText'] = $previewText; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email on which the campaign recipients will be able to reply to * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\CreateEmailCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\CreateEmailCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets attachmentUrl * * @return string */ public function getAttachmentUrl() { return $this->container['attachmentUrl']; } /** * Sets attachmentUrl * * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * * @return $this */ public function setAttachmentUrl($attachmentUrl) { $this->container['attachmentUrl'] = $attachmentUrl; return $this; } /** * Gets inlineImageActivation * * @return bool */ public function getInlineImageActivation() { return $this->container['inlineImageActivation']; } /** * Sets inlineImageActivation * * @param bool $inlineImageActivation Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts * * @return $this */ public function setInlineImageActivation($inlineImageActivation) { $this->container['inlineImageActivation'] = $inlineImageActivation; return $this; } /** * Gets mirrorActive * * @return bool */ public function getMirrorActive() { return $this->container['mirrorActive']; } /** * Sets mirrorActive * * @param bool $mirrorActive Use true to enable the mirror link * * @return $this */ public function setMirrorActive($mirrorActive) { $this->container['mirrorActive'] = $mirrorActive; return $this; } /** * Gets footer * * @return string */ public function getFooter() { return $this->container['footer']; } /** * Sets footer * * @param string $footer Footer of the email campaign * * @return $this */ public function setFooter($footer) { $this->container['footer'] = $footer; return $this; } /** * Gets header * * @return string */ public function getHeader() { return $this->container['header']; } /** * Sets header * * @param string $header Header of the email campaign * * @return $this */ public function setHeader($header) { $this->container['header'] = $header; return $this; } /** * Gets utmCampaign * * @return string */ public function getUtmCampaign() { return $this->container['utmCampaign']; } /** * Sets utmCampaign * * @param string $utmCampaign Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed * * @return $this */ public function setUtmCampaign($utmCampaign) { $this->container['utmCampaign'] = $utmCampaign; return $this; } /** * Gets params * * @return object */ public function getParams() { return $this->container['params']; } /** * Sets params * * @param object $params Pass the set of attributes to customize the type classic campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' * * @return $this */ public function setParams($params) { $this->container['params'] = $params; return $this; } /** * Gets sendAtBestTime * * @return bool */ public function getSendAtBestTime() { return $this->container['sendAtBestTime']; } /** * Sets sendAtBestTime * * @param bool $sendAtBestTime Set this to true if you want to send your campaign at best time. * * @return $this */ public function setSendAtBestTime($sendAtBestTime) { $this->container['sendAtBestTime'] = $sendAtBestTime; return $this; } /** * Gets abTesting * * @return bool */ public function getAbTesting() { return $this->container['abTesting']; } /** * Sets abTesting * * @param bool $abTesting Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B * * @return $this */ public function setAbTesting($abTesting) { $this->container['abTesting'] = $abTesting; return $this; } /** * Gets subjectA * * @return string */ public function getSubjectA() { return $this->container['subjectA']; } /** * Sets subjectA * * @param string $subjectA Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value * * @return $this */ public function setSubjectA($subjectA) { $this->container['subjectA'] = $subjectA; return $this; } /** * Gets subjectB * * @return string */ public function getSubjectB() { return $this->container['subjectB']; } /** * Sets subjectB * * @param string $subjectB Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value * * @return $this */ public function setSubjectB($subjectB) { $this->container['subjectB'] = $subjectB; return $this; } /** * Gets splitRule * * @return int */ public function getSplitRule() { return $this->container['splitRule']; } /** * Sets splitRule * * @param int $splitRule Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else * * @return $this */ public function setSplitRule($splitRule) { if (!is_null($splitRule) && ($splitRule > 50)) { throw new \InvalidArgumentException('invalid value for $splitRule when calling CreateEmailCampaign., must be smaller than or equal to 50.'); } if (!is_null($splitRule) && ($splitRule < 1)) { throw new \InvalidArgumentException('invalid value for $splitRule when calling CreateEmailCampaign., must be bigger than or equal to 1.'); } $this->container['splitRule'] = $splitRule; return $this; } /** * Gets winnerCriteria * * @return string */ public function getWinnerCriteria() { return $this->container['winnerCriteria']; } /** * Sets winnerCriteria * * @param string $winnerCriteria Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed * * @return $this */ public function setWinnerCriteria($winnerCriteria) { $allowedValues = $this->getWinnerCriteriaAllowableValues(); if (!is_null($winnerCriteria) && !in_array($winnerCriteria, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'winnerCriteria', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['winnerCriteria'] = $winnerCriteria; return $this; } /** * Gets winnerDelay * * @return int */ public function getWinnerDelay() { return $this->container['winnerDelay']; } /** * Sets winnerDelay * * @param int $winnerDelay Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed * * @return $this */ public function setWinnerDelay($winnerDelay) { if (!is_null($winnerDelay) && ($winnerDelay > 168)) { throw new \InvalidArgumentException('invalid value for $winnerDelay when calling CreateEmailCampaign., must be smaller than or equal to 168.'); } if (!is_null($winnerDelay) && ($winnerDelay < 1)) { throw new \InvalidArgumentException('invalid value for $winnerDelay when calling CreateEmailCampaign., must be bigger than or equal to 1.'); } $this->container['winnerDelay'] = $winnerDelay; return $this; } /** * Gets ipWarmupEnable * * @return bool */ public function getIpWarmupEnable() { return $this->container['ipWarmupEnable']; } /** * Sets ipWarmupEnable * * @param bool $ipWarmupEnable Available for dedicated ip clients. Set this to true if you wish to warm up your ip. * * @return $this */ public function setIpWarmupEnable($ipWarmupEnable) { $this->container['ipWarmupEnable'] = $ipWarmupEnable; return $this; } /** * Gets initialQuota * * @return int */ public function getInitialQuota() { return $this->container['initialQuota']; } /** * Sets initialQuota * * @param int $initialQuota Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. * * @return $this */ public function setInitialQuota($initialQuota) { $this->container['initialQuota'] = $initialQuota; return $this; } /** * Gets increaseRate * * @return int */ public function getIncreaseRate() { return $this->container['increaseRate']; } /** * Sets increaseRate * * @param int $increaseRate Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. * * @return $this */ public function setIncreaseRate($increaseRate) { if (!is_null($increaseRate) && ($increaseRate > 100)) { throw new \InvalidArgumentException('invalid value for $increaseRate when calling CreateEmailCampaign., must be smaller than or equal to 100.'); } if (!is_null($increaseRate) && ($increaseRate < 0)) { throw new \InvalidArgumentException('invalid value for $increaseRate when calling CreateEmailCampaign., must be bigger than or equal to 0.'); } $this->container['increaseRate'] = $increaseRate; return $this; } /** * Gets unsubscriptionPageId * * @return string */ public function getUnsubscriptionPageId() { return $this->container['unsubscriptionPageId']; } /** * Sets unsubscriptionPageId * * @param string $unsubscriptionPageId Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. * * @return $this */ public function setUnsubscriptionPageId($unsubscriptionPageId) { $this->container['unsubscriptionPageId'] = $unsubscriptionPageId; return $this; } /** * Gets updateFormId * * @return string */ public function getUpdateFormId() { return $this->container['updateFormId']; } /** * Sets updateFormId * * @param string $updateFormId Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. * * @return $this */ public function setUpdateFormId($updateFormId) { $this->container['updateFormId'] = $updateFormId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsAppConfig.php 0000644 00000035130 15021222673 0014304 0 ustar 00 <?php /** * GetWhatsAppConfig * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsAppConfig Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsAppConfig implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsAppConfig'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'whatsappBusinessAccountId' => 'string', 'sendingLimit' => 'string', 'phoneNumberQuality' => 'string', 'whatsappBusinessAccountStatus' => 'string', 'businessStatus' => 'string', 'phoneNumberNameStatus' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'whatsappBusinessAccountId' => null, 'sendingLimit' => null, 'phoneNumberQuality' => null, 'whatsappBusinessAccountStatus' => null, 'businessStatus' => null, 'phoneNumberNameStatus' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'whatsappBusinessAccountId' => 'whatsappBusinessAccountId', 'sendingLimit' => 'sendingLimit', 'phoneNumberQuality' => 'phoneNumberQuality', 'whatsappBusinessAccountStatus' => 'whatsappBusinessAccountStatus', 'businessStatus' => 'businessStatus', 'phoneNumberNameStatus' => 'phoneNumberNameStatus' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'whatsappBusinessAccountId' => 'setWhatsappBusinessAccountId', 'sendingLimit' => 'setSendingLimit', 'phoneNumberQuality' => 'setPhoneNumberQuality', 'whatsappBusinessAccountStatus' => 'setWhatsappBusinessAccountStatus', 'businessStatus' => 'setBusinessStatus', 'phoneNumberNameStatus' => 'setPhoneNumberNameStatus' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'whatsappBusinessAccountId' => 'getWhatsappBusinessAccountId', 'sendingLimit' => 'getSendingLimit', 'phoneNumberQuality' => 'getPhoneNumberQuality', 'whatsappBusinessAccountStatus' => 'getWhatsappBusinessAccountStatus', 'businessStatus' => 'getBusinessStatus', 'phoneNumberNameStatus' => 'getPhoneNumberNameStatus' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const PHONE_NUMBER_QUALITY_GREEN = 'GREEN'; const PHONE_NUMBER_QUALITY_YELLOW = 'YELLOW'; const PHONE_NUMBER_QUALITY_RED = 'RED'; const PHONE_NUMBER_NAME_STATUS_APPROVED = 'APPROVED'; const PHONE_NUMBER_NAME_STATUS_PENDING = 'PENDING'; const PHONE_NUMBER_NAME_STATUS_REJECTED = 'REJECTED'; /** * Gets allowable values of the enum * * @return string[] */ public function getPhoneNumberQualityAllowableValues() { return [ self::PHONE_NUMBER_QUALITY_GREEN, self::PHONE_NUMBER_QUALITY_YELLOW, self::PHONE_NUMBER_QUALITY_RED, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getPhoneNumberNameStatusAllowableValues() { return [ self::PHONE_NUMBER_NAME_STATUS_APPROVED, self::PHONE_NUMBER_NAME_STATUS_PENDING, self::PHONE_NUMBER_NAME_STATUS_REJECTED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['whatsappBusinessAccountId'] = isset($data['whatsappBusinessAccountId']) ? $data['whatsappBusinessAccountId'] : null; $this->container['sendingLimit'] = isset($data['sendingLimit']) ? $data['sendingLimit'] : null; $this->container['phoneNumberQuality'] = isset($data['phoneNumberQuality']) ? $data['phoneNumberQuality'] : null; $this->container['whatsappBusinessAccountStatus'] = isset($data['whatsappBusinessAccountStatus']) ? $data['whatsappBusinessAccountStatus'] : null; $this->container['businessStatus'] = isset($data['businessStatus']) ? $data['businessStatus'] : null; $this->container['phoneNumberNameStatus'] = isset($data['phoneNumberNameStatus']) ? $data['phoneNumberNameStatus'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getPhoneNumberQualityAllowableValues(); if (!is_null($this->container['phoneNumberQuality']) && !in_array($this->container['phoneNumberQuality'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'phoneNumberQuality', must be one of '%s'", implode("', '", $allowedValues) ); } $allowedValues = $this->getPhoneNumberNameStatusAllowableValues(); if (!is_null($this->container['phoneNumberNameStatus']) && !in_array($this->container['phoneNumberNameStatus'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'phoneNumberNameStatus', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets whatsappBusinessAccountId * * @return string */ public function getWhatsappBusinessAccountId() { return $this->container['whatsappBusinessAccountId']; } /** * Sets whatsappBusinessAccountId * * @param string $whatsappBusinessAccountId Id of the WhatsApp business account * * @return $this */ public function setWhatsappBusinessAccountId($whatsappBusinessAccountId) { $this->container['whatsappBusinessAccountId'] = $whatsappBusinessAccountId; return $this; } /** * Gets sendingLimit * * @return string */ public function getSendingLimit() { return $this->container['sendingLimit']; } /** * Sets sendingLimit * * @param string $sendingLimit Sending limit Information of the WhatsApp API account * * @return $this */ public function setSendingLimit($sendingLimit) { $this->container['sendingLimit'] = $sendingLimit; return $this; } /** * Gets phoneNumberQuality * * @return string */ public function getPhoneNumberQuality() { return $this->container['phoneNumberQuality']; } /** * Sets phoneNumberQuality * * @param string $phoneNumberQuality Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - **High (GREEN) , Medium (YELLOW) and Low(RED)** * * @return $this */ public function setPhoneNumberQuality($phoneNumberQuality) { $allowedValues = $this->getPhoneNumberQualityAllowableValues(); if (!is_null($phoneNumberQuality) && !in_array($phoneNumberQuality, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'phoneNumberQuality', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['phoneNumberQuality'] = $phoneNumberQuality; return $this; } /** * Gets whatsappBusinessAccountStatus * * @return string */ public function getWhatsappBusinessAccountStatus() { return $this->container['whatsappBusinessAccountStatus']; } /** * Sets whatsappBusinessAccountStatus * * @param string $whatsappBusinessAccountStatus Status information related to WhatsApp Api account * * @return $this */ public function setWhatsappBusinessAccountStatus($whatsappBusinessAccountStatus) { $this->container['whatsappBusinessAccountStatus'] = $whatsappBusinessAccountStatus; return $this; } /** * Gets businessStatus * * @return string */ public function getBusinessStatus() { return $this->container['businessStatus']; } /** * Sets businessStatus * * @param string $businessStatus Verification status information of the Business account * * @return $this */ public function setBusinessStatus($businessStatus) { $this->container['businessStatus'] = $businessStatus; return $this; } /** * Gets phoneNumberNameStatus * * @return string */ public function getPhoneNumberNameStatus() { return $this->container['phoneNumberNameStatus']; } /** * Sets phoneNumberNameStatus * * @param string $phoneNumberNameStatus Status of the name associated with WhatsApp Phone number * * @return $this */ public function setPhoneNumberNameStatus($phoneNumberNameStatus) { $allowedValues = $this->getPhoneNumberNameStatusAllowableValues(); if (!is_null($phoneNumberNameStatus) && !in_array($phoneNumberNameStatus, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'phoneNumberNameStatus', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['phoneNumberNameStatus'] = $phoneNumberNameStatus; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendTestEmail.php 0000644 00000016261 15021222673 0013474 0 ustar 00 <?php /** * SendTestEmail * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendTestEmail Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTestEmail implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendTestEmail'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'emailTo' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'emailTo' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'emailTo' => 'emailTo' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'emailTo' => 'setEmailTo' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'emailTo' => 'getEmailTo' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['emailTo'] = isset($data['emailTo']) ? $data['emailTo'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets emailTo * * @return string[] */ public function getEmailTo() { return $this->container['emailTo']; } /** * Sets emailTo * * @param string[] $emailTo List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day. * * @return $this */ public function setEmailTo($emailTo) { $this->container['emailTo'] = $emailTo; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAttributesEnumeration.php 0000644 00000017563 15021222673 0015776 0 ustar 00 <?php /** * GetAttributesEnumeration * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAttributesEnumeration Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributesEnumeration implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAttributes_enumeration'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'int', 'label' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => 'int64', 'label' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'label' => 'label' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'label' => 'setLabel' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'label' => 'getLabel' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['label'] = isset($data['label']) ? $data['label'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } if ($this->container['label'] === null) { $invalidProperties[] = "'label' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return int */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param int $value ID of Value of the \"category\" type attribute * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets label * * @return string */ public function getLabel() { return $this->container['label']; } /** * Sets label * * @param string $label Label of the \"category\" type attribute * * @return $this */ public function setLabel($label) { $this->container['label'] = $label; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountMarketingAutomation.php 0000644 00000017477 15021222673 0016744 0 ustar 00 <?php /** * GetAccountMarketingAutomation * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountMarketingAutomation Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountMarketingAutomation implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccount_marketingAutomation'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'key' => 'string', 'enabled' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'key' => null, 'enabled' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'key' => 'key', 'enabled' => 'enabled' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'key' => 'setKey', 'enabled' => 'setEnabled' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'key' => 'getKey', 'enabled' => 'getEnabled' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['key'] = isset($data['key']) ? $data['key'] : null; $this->container['enabled'] = isset($data['enabled']) ? $data['enabled'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['enabled'] === null) { $invalidProperties[] = "'enabled' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets key * * @return string */ public function getKey() { return $this->container['key']; } /** * Sets key * * @param string $key Marketing Automation Tracker ID * * @return $this */ public function setKey($key) { $this->container['key'] = $key; return $this; } /** * Gets enabled * * @return bool */ public function getEnabled() { return $this->container['enabled']; } /** * Sets enabled * * @param bool $enabled Status of Marketing Automation Plateform activation for your account (true=enabled, false=disabled) * * @return $this */ public function setEnabled($enabled) { $this->container['enabled'] = $enabled; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateExternalFeed.php 0000644 00000034271 15021222673 0014505 0 ustar 00 <?php /** * UpdateExternalFeed * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateExternalFeed Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateExternalFeed implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateExternalFeed'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'url' => 'string', 'authType' => 'string', 'username' => 'string', 'password' => 'string', 'token' => 'string', 'headers' => '\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]', 'maxRetries' => 'int', 'cache' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'url' => 'url', 'authType' => null, 'username' => null, 'password' => null, 'token' => null, 'headers' => null, 'maxRetries' => null, 'cache' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'url' => 'url', 'authType' => 'authType', 'username' => 'username', 'password' => 'password', 'token' => 'token', 'headers' => 'headers', 'maxRetries' => 'maxRetries', 'cache' => 'cache' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'url' => 'setUrl', 'authType' => 'setAuthType', 'username' => 'setUsername', 'password' => 'setPassword', 'token' => 'setToken', 'headers' => 'setHeaders', 'maxRetries' => 'setMaxRetries', 'cache' => 'setCache' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'url' => 'getUrl', 'authType' => 'getAuthType', 'username' => 'getUsername', 'password' => 'getPassword', 'token' => 'getToken', 'headers' => 'getHeaders', 'maxRetries' => 'getMaxRetries', 'cache' => 'getCache' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const AUTH_TYPE_BASIC = 'basic'; const AUTH_TYPE_TOKEN = 'token'; const AUTH_TYPE_NO_AUTH = 'noAuth'; /** * Gets allowable values of the enum * * @return string[] */ public function getAuthTypeAllowableValues() { return [ self::AUTH_TYPE_BASIC, self::AUTH_TYPE_TOKEN, self::AUTH_TYPE_NO_AUTH, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['authType'] = isset($data['authType']) ? $data['authType'] : null; $this->container['username'] = isset($data['username']) ? $data['username'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['token'] = isset($data['token']) ? $data['token'] : null; $this->container['headers'] = isset($data['headers']) ? $data['headers'] : null; $this->container['maxRetries'] = isset($data['maxRetries']) ? $data['maxRetries'] : null; $this->container['cache'] = isset($data['cache']) ? $data['cache'] : false; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($this->container['authType']) && !in_array($this->container['authType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ); } if (!is_null($this->container['maxRetries']) && ($this->container['maxRetries'] > 5)) { $invalidProperties[] = "invalid value for 'maxRetries', must be smaller than or equal to 5."; } if (!is_null($this->container['maxRetries']) && ($this->container['maxRetries'] < 0)) { $invalidProperties[] = "invalid value for 'maxRetries', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the feed * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the feed * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets authType * * @return string */ public function getAuthType() { return $this->container['authType']; } /** * Sets authType * * @param string $authType Auth type of the feed: * `basic` * `token` * `noAuth` * * @return $this */ public function setAuthType($authType) { $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($authType) && !in_array($authType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['authType'] = $authType; return $this; } /** * Gets username * * @return string */ public function getUsername() { return $this->container['username']; } /** * Sets username * * @param string $username Username for authType `basic` * * @return $this */ public function setUsername($username) { $this->container['username'] = $username; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password Password for authType `basic` * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets token * * @return string */ public function getToken() { return $this->container['token']; } /** * Sets token * * @param string $token Token for authType `token` * * @return $this */ public function setToken($token) { $this->container['token'] = $token; return $this; } /** * Gets headers * * @return \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] */ public function getHeaders() { return $this->container['headers']; } /** * Sets headers * * @param \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] $headers Custom headers for the feed * * @return $this */ public function setHeaders($headers) { $this->container['headers'] = $headers; return $this; } /** * Gets maxRetries * * @return int */ public function getMaxRetries() { return $this->container['maxRetries']; } /** * Sets maxRetries * * @param int $maxRetries Maximum number of retries on the feed url * * @return $this */ public function setMaxRetries($maxRetries) { if (!is_null($maxRetries) && ($maxRetries > 5)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling UpdateExternalFeed., must be smaller than or equal to 5.'); } if (!is_null($maxRetries) && ($maxRetries < 0)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling UpdateExternalFeed., must be bigger than or equal to 0.'); } $this->container['maxRetries'] = $maxRetries; return $this; } /** * Gets cache * * @return bool */ public function getCache() { return $this->container['cache']; } /** * Sets cache * * @param bool $cache Toggle caching of feed url response * * @return $this */ public function setCache($cache) { $this->container['cache'] = $cache; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Note.php 0000644 00000027335 15021222673 0011704 0 ustar 00 <?php /** * Note * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Note Class Doc Comment * * @category Class * @description Note Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Note implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'Note'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'text' => 'string', 'contactIds' => 'int[]', 'dealIds' => 'string[]', 'authorId' => 'object', 'createdAt' => '\DateTime', 'updatedAt' => '\DateTime' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'text' => null, 'contactIds' => null, 'dealIds' => null, 'authorId' => null, 'createdAt' => 'date-time', 'updatedAt' => 'date-time' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'text' => 'text', 'contactIds' => 'contactIds', 'dealIds' => 'dealIds', 'authorId' => 'authorId', 'createdAt' => 'createdAt', 'updatedAt' => 'updatedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'text' => 'setText', 'contactIds' => 'setContactIds', 'dealIds' => 'setDealIds', 'authorId' => 'setAuthorId', 'createdAt' => 'setCreatedAt', 'updatedAt' => 'setUpdatedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'text' => 'getText', 'contactIds' => 'getContactIds', 'dealIds' => 'getDealIds', 'authorId' => 'getAuthorId', 'createdAt' => 'getCreatedAt', 'updatedAt' => 'getUpdatedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['contactIds'] = isset($data['contactIds']) ? $data['contactIds'] : null; $this->container['dealIds'] = isset($data['dealIds']) ? $data['dealIds'] : null; $this->container['authorId'] = isset($data['authorId']) ? $data['authorId'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } if ((mb_strlen($this->container['text']) > 3000)) { $invalidProperties[] = "invalid value for 'text', the character length must be smaller than or equal to 3000."; } if ((mb_strlen($this->container['text']) < 1)) { $invalidProperties[] = "invalid value for 'text', the character length must be bigger than or equal to 1."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique note Id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text Text content of a note * * @return $this */ public function setText($text) { if ((mb_strlen($text) > 3000)) { throw new \InvalidArgumentException('invalid length for $text when calling Note., must be smaller than or equal to 3000.'); } if ((mb_strlen($text) < 1)) { throw new \InvalidArgumentException('invalid length for $text when calling Note., must be bigger than or equal to 1.'); } $this->container['text'] = $text; return $this; } /** * Gets contactIds * * @return int[] */ public function getContactIds() { return $this->container['contactIds']; } /** * Sets contactIds * * @param int[] $contactIds Contact ids linked to a note * * @return $this */ public function setContactIds($contactIds) { $this->container['contactIds'] = $contactIds; return $this; } /** * Gets dealIds * * @return string[] */ public function getDealIds() { return $this->container['dealIds']; } /** * Sets dealIds * * @param string[] $dealIds Deal ids linked to a note * * @return $this */ public function setDealIds($dealIds) { $this->container['dealIds'] = $dealIds; return $this; } /** * Gets authorId * * @return object */ public function getAuthorId() { return $this->container['authorId']; } /** * Sets authorId * * @param object $authorId Account details of user which created the note * * @return $this */ public function setAuthorId($authorId) { $this->container['authorId'] = $authorId; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Note created date/time * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets updatedAt * * @return \DateTime */ public function getUpdatedAt() { return $this->container['updatedAt']; } /** * Sets updatedAt * * @param \DateTime $updatedAt Note updated date/time * * @return $this */ public function setUpdatedAt($updatedAt) { $this->container['updatedAt'] = $updatedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CompanyAttributesInner.php 0000644 00000024063 15021222673 0015443 0 ustar 00 <?php /** * CompanyAttributesInner * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CompanyAttributesInner Class Doc Comment * * @category Class * @description List of attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompanyAttributesInner implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'CompanyAttributes_inner'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'internalName' => 'string', 'label' => 'string', 'attributeTypeName' => 'string', 'attributeOptions' => 'object[]', 'isRequired' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'internalName' => null, 'label' => null, 'attributeTypeName' => null, 'attributeOptions' => null, 'isRequired' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'internalName' => 'internalName', 'label' => 'label', 'attributeTypeName' => 'attributeTypeName', 'attributeOptions' => 'attributeOptions', 'isRequired' => 'isRequired' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'internalName' => 'setInternalName', 'label' => 'setLabel', 'attributeTypeName' => 'setAttributeTypeName', 'attributeOptions' => 'setAttributeOptions', 'isRequired' => 'setIsRequired' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'internalName' => 'getInternalName', 'label' => 'getLabel', 'attributeTypeName' => 'getAttributeTypeName', 'attributeOptions' => 'getAttributeOptions', 'isRequired' => 'getIsRequired' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['internalName'] = isset($data['internalName']) ? $data['internalName'] : null; $this->container['label'] = isset($data['label']) ? $data['label'] : null; $this->container['attributeTypeName'] = isset($data['attributeTypeName']) ? $data['attributeTypeName'] : null; $this->container['attributeOptions'] = isset($data['attributeOptions']) ? $data['attributeOptions'] : null; $this->container['isRequired'] = isset($data['isRequired']) ? $data['isRequired'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets internalName * * @return string */ public function getInternalName() { return $this->container['internalName']; } /** * Sets internalName * * @param string $internalName internalName * * @return $this */ public function setInternalName($internalName) { $this->container['internalName'] = $internalName; return $this; } /** * Gets label * * @return string */ public function getLabel() { return $this->container['label']; } /** * Sets label * * @param string $label label * * @return $this */ public function setLabel($label) { $this->container['label'] = $label; return $this; } /** * Gets attributeTypeName * * @return string */ public function getAttributeTypeName() { return $this->container['attributeTypeName']; } /** * Sets attributeTypeName * * @param string $attributeTypeName attributeTypeName * * @return $this */ public function setAttributeTypeName($attributeTypeName) { $this->container['attributeTypeName'] = $attributeTypeName; return $this; } /** * Gets attributeOptions * * @return object[] */ public function getAttributeOptions() { return $this->container['attributeOptions']; } /** * Sets attributeOptions * * @param object[] $attributeOptions attributeOptions * * @return $this */ public function setAttributeOptions($attributeOptions) { $this->container['attributeOptions'] = $attributeOptions; return $this; } /** * Gets isRequired * * @return bool */ public function getIsRequired() { return $this->container['isRequired']; } /** * Sets isRequired * * @param bool $isRequired isRequired * * @return $this */ public function setIsRequired($isRequired) { $this->container['isRequired'] = $isRequired; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmtpTemplateOverviewSender.php 0000644 00000020230 15021222673 0016731 0 ustar 00 <?php /** * GetSmtpTemplateOverviewSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmtpTemplateOverviewSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplateOverviewSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmtpTemplateOverview_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name From email for the template * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email From email for the template * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Sender id of the template * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetClient.php 0000644 00000022706 15021222673 0012652 0 ustar 00 <?php /** * GetClient * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetClient Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetClient implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getClient'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'firstName' => 'string', 'lastName' => 'string', 'companyName' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'firstName' => null, 'lastName' => null, 'companyName' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'firstName' => 'firstName', 'lastName' => 'lastName', 'companyName' => 'companyName' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'firstName' => 'setFirstName', 'lastName' => 'setLastName', 'companyName' => 'setCompanyName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'firstName' => 'getFirstName', 'lastName' => 'getLastName', 'companyName' => 'getCompanyName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['firstName'] = isset($data['firstName']) ? $data['firstName'] : null; $this->container['lastName'] = isset($data['lastName']) ? $data['lastName'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['firstName'] === null) { $invalidProperties[] = "'firstName' can't be null"; } if ($this->container['lastName'] === null) { $invalidProperties[] = "'lastName' can't be null"; } if ($this->container['companyName'] === null) { $invalidProperties[] = "'companyName' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Login Email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets firstName * * @return string */ public function getFirstName() { return $this->container['firstName']; } /** * Sets firstName * * @param string $firstName First Name * * @return $this */ public function setFirstName($firstName) { $this->container['firstName'] = $firstName; return $this; } /** * Gets lastName * * @return string */ public function getLastName() { return $this->container['lastName']; } /** * Sets lastName * * @param string $lastName Last Name * * @return $this */ public function setLastName($lastName) { $this->container['lastName'] = $lastName; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Name of the company * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetIpsFromSender.php 0000644 00000016216 15021222673 0014153 0 ustar 00 <?php /** * GetIpsFromSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetIpsFromSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpsFromSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getIpsFromSender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'ips' => '\Brevo\Client\Model\GetIpFromSender[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'ips' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'ips' => 'ips' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'ips' => 'setIps' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'ips' => 'getIps' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['ips'] === null) { $invalidProperties[] = "'ips' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets ips * * @return \Brevo\Client\Model\GetIpFromSender[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param \Brevo\Client\Model\GetIpFromSender[] $ips Dedicated IP(s) linked to a sender * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExternalFeedByUUID.php 0000644 00000042131 15021222673 0014756 0 ustar 00 <?php /** * GetExternalFeedByUUID * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExternalFeedByUUID Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExternalFeedByUUID implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExternalFeedByUUID'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'authType' => 'string', 'username' => 'string', 'password' => 'string', 'token' => 'string', 'headers' => '\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]', 'maxRetries' => 'int', 'cache' => 'bool', 'createdAt' => '\DateTime', 'modifiedAt' => '\DateTime' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4', 'name' => null, 'url' => 'url', 'authType' => null, 'username' => null, 'password' => null, 'token' => null, 'headers' => null, 'maxRetries' => null, 'cache' => null, 'createdAt' => 'date-time', 'modifiedAt' => 'date-time' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'authType' => 'authType', 'username' => 'username', 'password' => 'password', 'token' => 'token', 'headers' => 'headers', 'maxRetries' => 'maxRetries', 'cache' => 'cache', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'authType' => 'setAuthType', 'username' => 'setUsername', 'password' => 'setPassword', 'token' => 'setToken', 'headers' => 'setHeaders', 'maxRetries' => 'setMaxRetries', 'cache' => 'setCache', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'authType' => 'getAuthType', 'username' => 'getUsername', 'password' => 'getPassword', 'token' => 'getToken', 'headers' => 'getHeaders', 'maxRetries' => 'getMaxRetries', 'cache' => 'getCache', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const AUTH_TYPE_BASIC = 'basic'; const AUTH_TYPE_TOKEN = 'token'; const AUTH_TYPE_NO_AUTH = 'noAuth'; /** * Gets allowable values of the enum * * @return string[] */ public function getAuthTypeAllowableValues() { return [ self::AUTH_TYPE_BASIC, self::AUTH_TYPE_TOKEN, self::AUTH_TYPE_NO_AUTH, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['authType'] = isset($data['authType']) ? $data['authType'] : null; $this->container['username'] = isset($data['username']) ? $data['username'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['token'] = isset($data['token']) ? $data['token'] : null; $this->container['headers'] = isset($data['headers']) ? $data['headers'] : null; $this->container['maxRetries'] = isset($data['maxRetries']) ? $data['maxRetries'] : null; $this->container['cache'] = isset($data['cache']) ? $data['cache'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } if ($this->container['authType'] === null) { $invalidProperties[] = "'authType' can't be null"; } $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($this->container['authType']) && !in_array($this->container['authType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['headers'] === null) { $invalidProperties[] = "'headers' can't be null"; } if ($this->container['maxRetries'] === null) { $invalidProperties[] = "'maxRetries' can't be null"; } if (($this->container['maxRetries'] > 5)) { $invalidProperties[] = "invalid value for 'maxRetries', must be smaller than or equal to 5."; } if (($this->container['maxRetries'] < 0)) { $invalidProperties[] = "invalid value for 'maxRetries', must be bigger than or equal to 0."; } if ($this->container['cache'] === null) { $invalidProperties[] = "'cache' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id ID of the feed * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the feed * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the feed * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets authType * * @return string */ public function getAuthType() { return $this->container['authType']; } /** * Sets authType * * @param string $authType Auth type of the feed: * `basic` * `token` * `noAuth` * * @return $this */ public function setAuthType($authType) { $allowedValues = $this->getAuthTypeAllowableValues(); if (!in_array($authType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['authType'] = $authType; return $this; } /** * Gets username * * @return string */ public function getUsername() { return $this->container['username']; } /** * Sets username * * @param string $username Username for authType `basic` * * @return $this */ public function setUsername($username) { $this->container['username'] = $username; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password Password for authType `basic` * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets token * * @return string */ public function getToken() { return $this->container['token']; } /** * Sets token * * @param string $token Token for authType `token` * * @return $this */ public function setToken($token) { $this->container['token'] = $token; return $this; } /** * Gets headers * * @return \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] */ public function getHeaders() { return $this->container['headers']; } /** * Sets headers * * @param \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] $headers Custom headers for the feed * * @return $this */ public function setHeaders($headers) { $this->container['headers'] = $headers; return $this; } /** * Gets maxRetries * * @return int */ public function getMaxRetries() { return $this->container['maxRetries']; } /** * Sets maxRetries * * @param int $maxRetries Maximum number of retries on the feed url * * @return $this */ public function setMaxRetries($maxRetries) { if (($maxRetries > 5)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling GetExternalFeedByUUID., must be smaller than or equal to 5.'); } if (($maxRetries < 0)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling GetExternalFeedByUUID., must be bigger than or equal to 0.'); } $this->container['maxRetries'] = $maxRetries; return $this; } /** * Gets cache * * @return bool */ public function getCache() { return $this->container['cache']; } /** * Sets cache * * @param bool $cache Toggle caching of feed url response * * @return $this */ public function setCache($cache) { $this->container['cache'] = $cache; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Datetime on which the feed was created * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return \DateTime */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param \DateTime $modifiedAt Datetime on which the feed was modified * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendSmtpEmailMessageVersions.php 0000644 00000025603 15021222673 0016536 0 ustar 00 <?php /** * SendSmtpEmailMessageVersions * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendSmtpEmailMessageVersions Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailMessageVersions implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendSmtpEmail_messageVersions'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'to' => '\Brevo\Client\Model\SendSmtpEmailTo1[]', 'params' => 'map[string,object]', 'bcc' => '\Brevo\Client\Model\SendSmtpEmailBcc[]', 'cc' => '\Brevo\Client\Model\SendSmtpEmailCc[]', 'replyTo' => '\Brevo\Client\Model\SendSmtpEmailReplyTo1', 'subject' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'to' => null, 'params' => null, 'bcc' => null, 'cc' => null, 'replyTo' => null, 'subject' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'to' => 'to', 'params' => 'params', 'bcc' => 'bcc', 'cc' => 'cc', 'replyTo' => 'replyTo', 'subject' => 'subject' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'to' => 'setTo', 'params' => 'setParams', 'bcc' => 'setBcc', 'cc' => 'setCc', 'replyTo' => 'setReplyTo', 'subject' => 'setSubject' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'to' => 'getTo', 'params' => 'getParams', 'bcc' => 'getBcc', 'cc' => 'getCc', 'replyTo' => 'getReplyTo', 'subject' => 'getSubject' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['to'] = isset($data['to']) ? $data['to'] : null; $this->container['params'] = isset($data['params']) ? $data['params'] : null; $this->container['bcc'] = isset($data['bcc']) ? $data['bcc'] : null; $this->container['cc'] = isset($data['cc']) ? $data['cc'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['to'] === null) { $invalidProperties[] = "'to' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets to * * @return \Brevo\Client\Model\SendSmtpEmailTo1[] */ public function getTo() { return $this->container['to']; } /** * Sets to * * @param \Brevo\Client\Model\SendSmtpEmailTo1[] $to List of email addresses and names (_optional_) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] * * @return $this */ public function setTo($to) { $this->container['to'] = $to; return $this; } /** * Gets params * * @return map[string,object] */ public function getParams() { return $this->container['params']; } /** * Sets params * * @param map[string,object] $params Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. * * @return $this */ public function setParams($params) { $this->container['params'] = $params; return $this; } /** * Gets bcc * * @return \Brevo\Client\Model\SendSmtpEmailBcc[] */ public function getBcc() { return $this->container['bcc']; } /** * Sets bcc * * @param \Brevo\Client\Model\SendSmtpEmailBcc[] $bcc List of email addresses and names (optional) of the recipients in bcc * * @return $this */ public function setBcc($bcc) { $this->container['bcc'] = $bcc; return $this; } /** * Gets cc * * @return \Brevo\Client\Model\SendSmtpEmailCc[] */ public function getCc() { return $this->container['cc']; } /** * Sets cc * * @param \Brevo\Client\Model\SendSmtpEmailCc[] $cc List of email addresses and names (optional) of the recipients in cc * * @return $this */ public function setCc($cc) { $this->container['cc'] = $cc; return $this; } /** * Gets replyTo * * @return \Brevo\Client\Model\SendSmtpEmailReplyTo1 */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param \Brevo\Client\Model\SendSmtpEmailReplyTo1 $replyTo replyTo * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Custom subject specific to message version * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSendersList.php 0000644 00000016177 15021222673 0013700 0 ustar 00 <?php /** * GetSendersList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSendersList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSendersList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'senders' => '\Brevo\Client\Model\GetSendersListSenders[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'senders' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'senders' => 'senders' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'senders' => 'setSenders' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'senders' => 'getSenders' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['senders'] = isset($data['senders']) ? $data['senders'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets senders * * @return \Brevo\Client\Model\GetSendersListSenders[] */ public function getSenders() { return $this->container['senders']; } /** * Sets senders * * @param \Brevo\Client\Model\GetSendersListSenders[] $senders List of the senders available in your account * * @return $this */ public function setSenders($senders) { $this->container['senders'] = $senders; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateSmtpTemplate.php 0000644 00000033643 15021222673 0014560 0 ustar 00 <?php /** * UpdateSmtpTemplate * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateSmtpTemplate Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmtpTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateSmtpTemplate'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'tag' => 'string', 'sender' => '\Brevo\Client\Model\UpdateSmtpTemplateSender', 'templateName' => 'string', 'htmlContent' => 'string', 'htmlUrl' => 'string', 'subject' => 'string', 'replyTo' => 'string', 'toField' => 'string', 'attachmentUrl' => 'string', 'isActive' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'tag' => null, 'sender' => null, 'templateName' => null, 'htmlContent' => null, 'htmlUrl' => 'url', 'subject' => null, 'replyTo' => 'email', 'toField' => null, 'attachmentUrl' => 'url', 'isActive' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'tag' => 'tag', 'sender' => 'sender', 'templateName' => 'templateName', 'htmlContent' => 'htmlContent', 'htmlUrl' => 'htmlUrl', 'subject' => 'subject', 'replyTo' => 'replyTo', 'toField' => 'toField', 'attachmentUrl' => 'attachmentUrl', 'isActive' => 'isActive' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'tag' => 'setTag', 'sender' => 'setSender', 'templateName' => 'setTemplateName', 'htmlContent' => 'setHtmlContent', 'htmlUrl' => 'setHtmlUrl', 'subject' => 'setSubject', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'attachmentUrl' => 'setAttachmentUrl', 'isActive' => 'setIsActive' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'tag' => 'getTag', 'sender' => 'getSender', 'templateName' => 'getTemplateName', 'htmlContent' => 'getHtmlContent', 'htmlUrl' => 'getHtmlUrl', 'subject' => 'getSubject', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'attachmentUrl' => 'getAttachmentUrl', 'isActive' => 'getIsActive' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['templateName'] = isset($data['templateName']) ? $data['templateName'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['htmlUrl'] = isset($data['htmlUrl']) ? $data['htmlUrl'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['attachmentUrl'] = isset($data['attachmentUrl']) ? $data['attachmentUrl'] : null; $this->container['isActive'] = isset($data['isActive']) ? $data['isActive'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the template * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\UpdateSmtpTemplateSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\UpdateSmtpTemplateSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets templateName * * @return string */ public function getTemplateName() { return $this->container['templateName']; } /** * Sets templateName * * @param string $templateName Name of the template * * @return $this */ public function setTemplateName($templateName) { $this->container['templateName'] = $templateName; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters) * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets htmlUrl * * @return string */ public function getHtmlUrl() { return $this->container['htmlUrl']; } /** * Sets htmlUrl * * @param string $htmlUrl Required if htmlContent is empty. URL to the body of the email (HTML) * * @return $this */ public function setHtmlUrl($htmlUrl) { $this->container['htmlUrl'] = $htmlUrl; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the email * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email on which campaign recipients will be able to reply to * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets attachmentUrl * * @return string */ public function getAttachmentUrl() { return $this->container['attachmentUrl']; } /** * Sets attachmentUrl * * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * * @return $this */ public function setAttachmentUrl($attachmentUrl) { $this->container['attachmentUrl'] = $attachmentUrl; return $this; } /** * Gets isActive * * @return bool */ public function getIsActive() { return $this->container['isActive']; } /** * Sets isActive * * @param bool $isActive Status of the template. isActive = false means template is inactive, isActive = true means template is active * * @return $this */ public function setIsActive($isActive) { $this->container['isActive'] = $isActive; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsLinks.php 0000644 00000022543 15021222673 0021071 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsLinks * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsLinks Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsLinks implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_links'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'eventTime' => 'string', 'ip' => 'string', 'url' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => 'int64', 'eventTime' => null, 'ip' => null, 'url' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'eventTime' => 'eventTime', 'ip' => 'ip', 'url' => 'url' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'eventTime' => 'setEventTime', 'ip' => 'setIp', 'url' => 'setUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'eventTime' => 'getEventTime', 'ip' => 'getIp', 'url' => 'getUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of clicks on this link for the campaign * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has clicked on the link * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the clicked link * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetScheduledEmailByBatchId.php 0000644 00000017412 15021222673 0016014 0 ustar 00 <?php /** * GetScheduledEmailByBatchId * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetScheduledEmailByBatchId Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByBatchId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getScheduledEmailByBatchId'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'count' => 'int', 'batches' => '\Brevo\Client\Model\GetScheduledEmailByBatchIdBatches[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'count' => null, 'batches' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'count' => 'count', 'batches' => 'batches' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'count' => 'setCount', 'batches' => 'setBatches' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'count' => 'getCount', 'batches' => 'getBatches' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['batches'] = isset($data['batches']) ? $data['batches'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Total number of batches * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets batches * * @return \Brevo\Client\Model\GetScheduledEmailByBatchIdBatches[] */ public function getBatches() { return $this->container['batches']; } /** * Sets batches * * @param \Brevo\Client\Model\GetScheduledEmailByBatchIdBatches[] $batches batches * * @return $this */ public function setBatches($batches) { $this->container['batches'] = $batches; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountActivityLogs.php 0000644 00000024442 15021222673 0015371 0 ustar 00 <?php /** * GetAccountActivityLogs * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountActivityLogs Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountActivityLogs implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccountActivity_logs'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'action' => 'string', 'date' => 'string', 'userEmail' => 'string', 'userIp' => 'string', 'userAgent' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'action' => null, 'date' => null, 'userEmail' => null, 'userIp' => null, 'userAgent' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'action' => 'action', 'date' => 'date', 'userEmail' => 'user_email', 'userIp' => 'user_ip', 'userAgent' => 'user_agent' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'action' => 'setAction', 'date' => 'setDate', 'userEmail' => 'setUserEmail', 'userIp' => 'setUserIp', 'userAgent' => 'setUserAgent' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'action' => 'getAction', 'date' => 'getDate', 'userEmail' => 'getUserEmail', 'userIp' => 'getUserIp', 'userAgent' => 'getUserAgent' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['action'] = isset($data['action']) ? $data['action'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['userEmail'] = isset($data['userEmail']) ? $data['userEmail'] : null; $this->container['userIp'] = isset($data['userIp']) ? $data['userIp'] : null; $this->container['userAgent'] = isset($data['userAgent']) ? $data['userAgent'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['action'] === null) { $invalidProperties[] = "'action' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['userEmail'] === null) { $invalidProperties[] = "'userEmail' can't be null"; } if ($this->container['userIp'] === null) { $invalidProperties[] = "'userIp' can't be null"; } if ($this->container['userAgent'] === null) { $invalidProperties[] = "'userAgent' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets action * * @return string */ public function getAction() { return $this->container['action']; } /** * Sets action * * @param string $action Type of activity in the account. * * @return $this */ public function setAction($action) { $this->container['action'] = $action; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date Time of the activity. * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets userEmail * * @return string */ public function getUserEmail() { return $this->container['userEmail']; } /** * Sets userEmail * * @param string $userEmail Email address of the user who performed activity in the account. * * @return $this */ public function setUserEmail($userEmail) { $this->container['userEmail'] = $userEmail; return $this; } /** * Gets userIp * * @return string */ public function getUserIp() { return $this->container['userIp']; } /** * Sets userIp * * @param string $userIp IP address of the user who performed activity in the account. * * @return $this */ public function setUserIp($userIp) { $this->container['userIp'] = $userIp; return $this; } /** * Gets userAgent * * @return string */ public function getUserAgent() { return $this->container['userAgent']; } /** * Sets userAgent * * @param string $userAgent Browser details of the user who performed the activity. * * @return $this */ public function setUserAgent($userAgent) { $this->container['userAgent'] = $userAgent; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSmtpTemplateSender.php 0000644 00000021113 15021222673 0015667 0 ustar 00 <?php /** * CreateSmtpTemplateSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSmtpTemplateSender Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpTemplateSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSmtpTemplate_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the sender. If not passed, will be set to default * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email of the sender * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountUpdatePlanRequestCredits.php 0000644 00000016106 15021222673 0017704 0 ustar 00 <?php /** * SubAccountUpdatePlanRequestCredits * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountUpdatePlanRequestCredits Class Doc Comment * * @category Class * @description Credit details to update * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequestCredits implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountUpdatePlanRequest_credits'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return int */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param int $email Number of email credits * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildInfo.php 0000644 00000023753 15021222673 0013276 0 ustar 00 <?php /** * GetChildInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \Brevo\Client\ObjectSerializer; /** * GetChildInfo Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfo extends GetClient { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'credits' => '\Brevo\Client\Model\GetChildInfoCredits', 'statistics' => '\Brevo\Client\Model\GetChildInfoStatistics', 'password' => 'string', 'ips' => 'string[]', 'apiKeys' => '\Brevo\Client\Model\GetChildInfoApiKeys' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'credits' => null, 'statistics' => null, 'password' => 'password', 'ips' => null, 'apiKeys' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes + parent::swaggerTypes(); } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats + parent::swaggerFormats(); } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'credits' => 'credits', 'statistics' => 'statistics', 'password' => 'password', 'ips' => 'ips', 'apiKeys' => 'apiKeys' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'credits' => 'setCredits', 'statistics' => 'setStatistics', 'password' => 'setPassword', 'ips' => 'setIps', 'apiKeys' => 'setApiKeys' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'credits' => 'getCredits', 'statistics' => 'getStatistics', 'password' => 'getPassword', 'ips' => 'getIps', 'apiKeys' => 'getApiKeys' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return parent::attributeMap() + self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return parent::setters() + self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return parent::getters() + self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { parent::__construct($data); $this->container['credits'] = isset($data['credits']) ? $data['credits'] : null; $this->container['statistics'] = isset($data['statistics']) ? $data['statistics'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; $this->container['apiKeys'] = isset($data['apiKeys']) ? $data['apiKeys'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = parent::listInvalidProperties(); if ($this->container['password'] === null) { $invalidProperties[] = "'password' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets credits * * @return \Brevo\Client\Model\GetChildInfoCredits */ public function getCredits() { return $this->container['credits']; } /** * Sets credits * * @param \Brevo\Client\Model\GetChildInfoCredits $credits credits * * @return $this */ public function setCredits($credits) { $this->container['credits'] = $credits; return $this; } /** * Gets statistics * * @return \Brevo\Client\Model\GetChildInfoStatistics */ public function getStatistics() { return $this->container['statistics']; } /** * Sets statistics * * @param \Brevo\Client\Model\GetChildInfoStatistics $statistics statistics * * @return $this */ public function setStatistics($statistics) { $this->container['statistics'] = $statistics; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password The encrypted password of child account * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets ips * * @return string[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param string[] $ips IP(s) associated to a child account user * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Gets apiKeys * * @return \Brevo\Client\Model\GetChildInfoApiKeys */ public function getApiKeys() { return $this->container['apiKeys']; } /** * Sets apiKeys * * @param \Brevo\Client\Model\GetChildInfoApiKeys $apiKeys apiKeys * * @return $this */ public function setApiKeys($apiKeys) { $this->container['apiKeys'] = $apiKeys; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatistics.php 0000644 00000035106 15021222673 0020067 0 ustar 00 <?php /** * GetExtendedContactDetailsStatistics * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatistics Class Doc Comment * * @category Class * @description Campaign statistics of the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatistics implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'messagesSent' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'hardBounces' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'softBounces' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'complaints' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]', 'unsubscriptions' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptions', 'opened' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsOpened[]', 'clicked' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsClicked[]', 'transacAttributes' => 'object[]', 'delivered' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'messagesSent' => null, 'hardBounces' => null, 'softBounces' => null, 'complaints' => null, 'unsubscriptions' => null, 'opened' => null, 'clicked' => null, 'transacAttributes' => null, 'delivered' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'messagesSent' => 'messagesSent', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'complaints' => 'complaints', 'unsubscriptions' => 'unsubscriptions', 'opened' => 'opened', 'clicked' => 'clicked', 'transacAttributes' => 'transacAttributes', 'delivered' => 'delivered' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'messagesSent' => 'setMessagesSent', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'complaints' => 'setComplaints', 'unsubscriptions' => 'setUnsubscriptions', 'opened' => 'setOpened', 'clicked' => 'setClicked', 'transacAttributes' => 'setTransacAttributes', 'delivered' => 'setDelivered' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'messagesSent' => 'getMessagesSent', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'complaints' => 'getComplaints', 'unsubscriptions' => 'getUnsubscriptions', 'opened' => 'getOpened', 'clicked' => 'getClicked', 'transacAttributes' => 'getTransacAttributes', 'delivered' => 'getDelivered' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['messagesSent'] = isset($data['messagesSent']) ? $data['messagesSent'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['complaints'] = isset($data['complaints']) ? $data['complaints'] : null; $this->container['unsubscriptions'] = isset($data['unsubscriptions']) ? $data['unsubscriptions'] : null; $this->container['opened'] = isset($data['opened']) ? $data['opened'] : null; $this->container['clicked'] = isset($data['clicked']) ? $data['clicked'] : null; $this->container['transacAttributes'] = isset($data['transacAttributes']) ? $data['transacAttributes'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets messagesSent * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getMessagesSent() { return $this->container['messagesSent']; } /** * Sets messagesSent * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $messagesSent Listing of the sent campaign for the contact * * @return $this */ public function setMessagesSent($messagesSent) { $this->container['messagesSent'] = $messagesSent; return $this; } /** * Gets hardBounces * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $hardBounces Listing of the hardbounes generated by the contact * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $softBounces Listing of the softbounes generated by the contact * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets complaints * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getComplaints() { return $this->container['complaints']; } /** * Sets complaints * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $complaints Listing of the complaints generated by the contact * * @return $this */ public function setComplaints($complaints) { $this->container['complaints'] = $complaints; return $this; } /** * Gets unsubscriptions * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptions */ public function getUnsubscriptions() { return $this->container['unsubscriptions']; } /** * Sets unsubscriptions * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsUnsubscriptions $unsubscriptions unsubscriptions * * @return $this */ public function setUnsubscriptions($unsubscriptions) { $this->container['unsubscriptions'] = $unsubscriptions; return $this; } /** * Gets opened * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsOpened[] */ public function getOpened() { return $this->container['opened']; } /** * Sets opened * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsOpened[] $opened Listing of the openings generated by the contact * * @return $this */ public function setOpened($opened) { $this->container['opened'] = $opened; return $this; } /** * Gets clicked * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsClicked[] */ public function getClicked() { return $this->container['clicked']; } /** * Sets clicked * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsClicked[] $clicked Listing of the clicks generated by the contact * * @return $this */ public function setClicked($clicked) { $this->container['clicked'] = $clicked; return $this; } /** * Gets transacAttributes * * @return object[] */ public function getTransacAttributes() { return $this->container['transacAttributes']; } /** * Sets transacAttributes * * @param object[] $transacAttributes Listing of the transactional attributes for the contact * * @return $this */ public function setTransacAttributes($transacAttributes) { $this->container['transacAttributes'] = $transacAttributes; return $this; } /** * Gets delivered * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsMessagesSent[] $delivered Listing of the delivered campaign for the contact * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/PostContactInfo.php 0000644 00000016360 15021222673 0014050 0 ustar 00 <?php /** * PostContactInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * PostContactInfo Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostContactInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'postContactInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'contacts' => '\Brevo\Client\Model\PostContactInfoContacts' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'contacts' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'contacts' => 'contacts' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'contacts' => 'setContacts' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'contacts' => 'getContacts' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['contacts'] = isset($data['contacts']) ? $data['contacts'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['contacts'] === null) { $invalidProperties[] = "'contacts' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets contacts * * @return \Brevo\Client\Model\PostContactInfoContacts */ public function getContacts() { return $this->container['contacts']; } /** * Sets contacts * * @param \Brevo\Client\Model\PostContactInfoContacts $contacts contacts * * @return $this */ public function setContacts($contacts) { $this->container['contacts'] = $contacts; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsCampaignStats.php 0000644 00000030110 15021222673 0014641 0 ustar 00 <?php /** * GetSmsCampaignStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsCampaignStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsCampaignStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'delivered' => 'int', 'sent' => 'int', 'processing' => 'int', 'softBounces' => 'int', 'hardBounces' => 'int', 'unsubscriptions' => 'int', 'answered' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'delivered' => 'int64', 'sent' => 'int64', 'processing' => 'int64', 'softBounces' => 'int64', 'hardBounces' => 'int64', 'unsubscriptions' => 'int64', 'answered' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'delivered' => 'delivered', 'sent' => 'sent', 'processing' => 'processing', 'softBounces' => 'softBounces', 'hardBounces' => 'hardBounces', 'unsubscriptions' => 'unsubscriptions', 'answered' => 'answered' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'delivered' => 'setDelivered', 'sent' => 'setSent', 'processing' => 'setProcessing', 'softBounces' => 'setSoftBounces', 'hardBounces' => 'setHardBounces', 'unsubscriptions' => 'setUnsubscriptions', 'answered' => 'setAnswered' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'delivered' => 'getDelivered', 'sent' => 'getSent', 'processing' => 'getProcessing', 'softBounces' => 'getSoftBounces', 'hardBounces' => 'getHardBounces', 'unsubscriptions' => 'getUnsubscriptions', 'answered' => 'getAnswered' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['sent'] = isset($data['sent']) ? $data['sent'] : null; $this->container['processing'] = isset($data['processing']) ? $data['processing'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['unsubscriptions'] = isset($data['unsubscriptions']) ? $data['unsubscriptions'] : null; $this->container['answered'] = isset($data['answered']) ? $data['answered'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['delivered'] === null) { $invalidProperties[] = "'delivered' can't be null"; } if ($this->container['sent'] === null) { $invalidProperties[] = "'sent' can't be null"; } if ($this->container['processing'] === null) { $invalidProperties[] = "'processing' can't be null"; } if ($this->container['softBounces'] === null) { $invalidProperties[] = "'softBounces' can't be null"; } if ($this->container['hardBounces'] === null) { $invalidProperties[] = "'hardBounces' can't be null"; } if ($this->container['unsubscriptions'] === null) { $invalidProperties[] = "'unsubscriptions' can't be null"; } if ($this->container['answered'] === null) { $invalidProperties[] = "'answered' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered SMS * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets sent * * @return int */ public function getSent() { return $this->container['sent']; } /** * Sets sent * * @param int $sent Number of sent SMS * * @return $this */ public function setSent($sent) { $this->container['sent'] = $sent; return $this; } /** * Gets processing * * @return int */ public function getProcessing() { return $this->container['processing']; } /** * Sets processing * * @param int $processing Number of processing SMS * * @return $this */ public function setProcessing($processing) { $this->container['processing'] = $processing; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounced SMS * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of hardbounced SMS * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets unsubscriptions * * @return int */ public function getUnsubscriptions() { return $this->container['unsubscriptions']; } /** * Sets unsubscriptions * * @param int $unsubscriptions Number of unsubscription SMS * * @return $this */ public function setUnsubscriptions($unsubscriptions) { $this->container['unsubscriptions'] = $unsubscriptions; return $this; } /** * Gets answered * * @return int */ public function getAnswered() { return $this->container['answered']; } /** * Sets answered * * @param int $answered Number of replies to the SMS * * @return $this */ public function setAnswered($answered) { $this->container['answered'] = $answered; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetUserPermission.php 0000644 00000021534 15021222673 0014421 0 ustar 00 <?php /** * GetUserPermission * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetUserPermission Class Doc Comment * * @category Class * @description Check user permission * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetUserPermission implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getUserPermission'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'status' => 'string', 'privileges' => '\Brevo\Client\Model\GetUserPermissionPrivileges[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => null, 'status' => null, 'privileges' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'status' => 'status', 'privileges' => 'privileges' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'status' => 'setStatus', 'privileges' => 'setPrivileges' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'status' => 'getStatus', 'privileges' => 'getPrivileges' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['privileges'] = isset($data['privileges']) ? $data['privileges'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } if ($this->container['privileges'] === null) { $invalidProperties[] = "'privileges' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address of the user. * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the invited user. * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Gets privileges * * @return \Brevo\Client\Model\GetUserPermissionPrivileges[] */ public function getPrivileges() { return $this->container['privileges']; } /** * Sets privileges * * @param \Brevo\Client\Model\GetUserPermissionPrivileges[] $privileges Granular feature permissions given to the user. * * @return $this */ public function setPrivileges($privileges) { $this->container['privileges'] = $privileges; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse2001.php 0000644 00000021212 15021222673 0014223 0 ustar 00 <?php /** * InlineResponse2001 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse2001 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2001 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_200_1'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'defaultCoupon' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4', 'name' => 'uuidv4', 'defaultCoupon' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'defaultCoupon' => 'defaultCoupon' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'defaultCoupon' => 'setDefaultCoupon' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'defaultCoupon' => 'getDefaultCoupon' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['defaultCoupon'] = isset($data['defaultCoupon']) ? $data['defaultCoupon'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['defaultCoupon'] === null) { $invalidProperties[] = "'defaultCoupon' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id The id of the collection * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name The name of the collection * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets defaultCoupon * * @return string */ public function getDefaultCoupon() { return $this->container['defaultCoupon']; } /** * Sets defaultCoupon * * @param string $defaultCoupon The default coupon of the collection * * @return $this */ public function setDefaultCoupon($defaultCoupon) { $this->container['defaultCoupon'] = $defaultCoupon; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSmsCampaignOverview.php 0000644 00000033441 15021222673 0015363 0 ustar 00 <?php /** * GetSmsCampaignOverview * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSmsCampaignOverview Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignOverview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSmsCampaignOverview'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'status' => 'string', 'content' => 'string', 'scheduledAt' => 'string', 'sender' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'status' => null, 'content' => null, 'scheduledAt' => null, 'sender' => null, 'createdAt' => null, 'modifiedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'status' => 'status', 'content' => 'content', 'scheduledAt' => 'scheduledAt', 'sender' => 'sender', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'status' => 'setStatus', 'content' => 'setContent', 'scheduledAt' => 'setScheduledAt', 'sender' => 'setSender', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'status' => 'getStatus', 'content' => 'getContent', 'scheduledAt' => 'getScheduledAt', 'sender' => 'getSender', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_DRAFT = 'draft'; const STATUS_SENT = 'sent'; const STATUS_ARCHIVE = 'archive'; const STATUS_QUEUED = 'queued'; const STATUS_SUSPENDED = 'suspended'; const STATUS_IN_PROCESS = 'inProcess'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_DRAFT, self::STATUS_SENT, self::STATUS_ARCHIVE, self::STATUS_QUEUED, self::STATUS_SUSPENDED, self::STATUS_IN_PROCESS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['content'] === null) { $invalidProperties[] = "'content' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the SMS Campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the SMS Campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the SMS Campaign * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Content of the SMS Campaign * * @return $this */ public function setContent($content) { $this->container['content'] = $content; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Sender of the SMS Campaign * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCampaignRecipients.php 0000644 00000017757 15021222673 0015213 0 ustar 00 <?php /** * GetCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCampaignRecipients Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCampaignRecipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'lists' => 'int[]', 'exclusionLists' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'lists' => 'int64', 'exclusionLists' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'lists' => 'lists', 'exclusionLists' => 'exclusionLists' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'lists' => 'setLists', 'exclusionLists' => 'setExclusionLists' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'lists' => 'getLists', 'exclusionLists' => 'getExclusionLists' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['lists'] = isset($data['lists']) ? $data['lists'] : null; $this->container['exclusionLists'] = isset($data['exclusionLists']) ? $data['exclusionLists'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['lists'] === null) { $invalidProperties[] = "'lists' can't be null"; } if ($this->container['exclusionLists'] === null) { $invalidProperties[] = "'exclusionLists' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets lists * * @return int[] */ public function getLists() { return $this->container['lists']; } /** * Sets lists * * @param int[] $lists lists * * @return $this */ public function setLists($lists) { $this->container['lists'] = $lists; return $this; } /** * Gets exclusionLists * * @return int[] */ public function getExclusionLists() { return $this->container['exclusionLists']; } /** * Sets exclusionLists * * @param int[] $exclusionLists exclusionLists * * @return $this */ public function setExclusionLists($exclusionLists) { $this->container['exclusionLists'] = $exclusionLists; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateFolder.php 0000644 00000015711 15021222673 0014474 0 ustar 00 <?php /** * CreateUpdateFolder * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateFolder Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateFolder implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateFolder'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the folder * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetProductDetails.php 0000644 00000042537 15021222673 0014366 0 ustar 00 <?php /** * GetProductDetails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetProductDetails Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProductDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getProductDetails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => 'string[]', 'parentId' => 'string', 's3Original' => 'string', 's3ThumbAnalytics' => 'string', 'metaInfo' => 'object', 's3ThumbEditor' => 'string', 'isDeleted' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'string', 'name' => 'string', 'createdAt' => null, 'modifiedAt' => null, 'url' => 'string', 'imageUrl' => 'string', 'sku' => 'string', 'price' => 'float', 'categories' => null, 'parentId' => 'string', 's3Original' => 'string', 's3ThumbAnalytics' => 'string', 'metaInfo' => null, 's3ThumbEditor' => 'string', 'isDeleted' => 'string' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'url' => 'url', 'imageUrl' => 'imageUrl', 'sku' => 'sku', 'price' => 'price', 'categories' => 'categories', 'parentId' => 'parentId', 's3Original' => 's3Original', 's3ThumbAnalytics' => 's3ThumbAnalytics', 'metaInfo' => 'metaInfo', 's3ThumbEditor' => 's3ThumbEditor', 'isDeleted' => 'isDeleted' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'url' => 'setUrl', 'imageUrl' => 'setImageUrl', 'sku' => 'setSku', 'price' => 'setPrice', 'categories' => 'setCategories', 'parentId' => 'setParentId', 's3Original' => 'setS3Original', 's3ThumbAnalytics' => 'setS3ThumbAnalytics', 'metaInfo' => 'setMetaInfo', 's3ThumbEditor' => 'setS3ThumbEditor', 'isDeleted' => 'setIsDeleted' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'url' => 'getUrl', 'imageUrl' => 'getImageUrl', 'sku' => 'getSku', 'price' => 'getPrice', 'categories' => 'getCategories', 'parentId' => 'getParentId', 's3Original' => 'getS3Original', 's3ThumbAnalytics' => 'getS3ThumbAnalytics', 'metaInfo' => 'getMetaInfo', 's3ThumbEditor' => 'getS3ThumbEditor', 'isDeleted' => 'getIsDeleted' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['imageUrl'] = isset($data['imageUrl']) ? $data['imageUrl'] : null; $this->container['sku'] = isset($data['sku']) ? $data['sku'] : null; $this->container['price'] = isset($data['price']) ? $data['price'] : null; $this->container['categories'] = isset($data['categories']) ? $data['categories'] : null; $this->container['parentId'] = isset($data['parentId']) ? $data['parentId'] : null; $this->container['s3Original'] = isset($data['s3Original']) ? $data['s3Original'] : null; $this->container['s3ThumbAnalytics'] = isset($data['s3ThumbAnalytics']) ? $data['s3ThumbAnalytics'] : null; $this->container['metaInfo'] = isset($data['metaInfo']) ? $data['metaInfo'] : null; $this->container['s3ThumbEditor'] = isset($data['s3ThumbEditor']) ? $data['s3ThumbEditor'] : null; $this->container['isDeleted'] = isset($data['isDeleted']) ? $data['isDeleted'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } if ($this->container['s3ThumbAnalytics'] === null) { $invalidProperties[] = "'s3ThumbAnalytics' can't be null"; } if ($this->container['s3ThumbEditor'] === null) { $invalidProperties[] = "'s3ThumbEditor' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Product ID for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the product for which you requested the details * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the product * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets imageUrl * * @return string */ public function getImageUrl() { return $this->container['imageUrl']; } /** * Sets imageUrl * * @param string $imageUrl Absolute URL to the cover image of the product * * @return $this */ public function setImageUrl($imageUrl) { $this->container['imageUrl'] = $imageUrl; return $this; } /** * Gets sku * * @return string */ public function getSku() { return $this->container['sku']; } /** * Sets sku * * @param string $sku Product identifier from the shop * * @return $this */ public function setSku($sku) { $this->container['sku'] = $sku; return $this; } /** * Gets price * * @return float */ public function getPrice() { return $this->container['price']; } /** * Sets price * * @param float $price Price of the product * * @return $this */ public function setPrice($price) { $this->container['price'] = $price; return $this; } /** * Gets categories * * @return string[] */ public function getCategories() { return $this->container['categories']; } /** * Sets categories * * @param string[] $categories Category ID-s of the product * * @return $this */ public function setCategories($categories) { $this->container['categories'] = $categories; return $this; } /** * Gets parentId * * @return string */ public function getParentId() { return $this->container['parentId']; } /** * Sets parentId * * @param string $parentId Parent product id of the product * * @return $this */ public function setParentId($parentId) { $this->container['parentId'] = $parentId; return $this; } /** * Gets s3Original * * @return string */ public function getS3Original() { return $this->container['s3Original']; } /** * Sets s3Original * * @param string $s3Original S3 url of original image * * @return $this */ public function setS3Original($s3Original) { $this->container['s3Original'] = $s3Original; return $this; } /** * Gets s3ThumbAnalytics * * @return string */ public function getS3ThumbAnalytics() { return $this->container['s3ThumbAnalytics']; } /** * Sets s3ThumbAnalytics * * @param string $s3ThumbAnalytics S3 thumbnail url of original image in 120x120 dimension for analytics section * * @return $this */ public function setS3ThumbAnalytics($s3ThumbAnalytics) { $this->container['s3ThumbAnalytics'] = $s3ThumbAnalytics; return $this; } /** * Gets metaInfo * * @return object */ public function getMetaInfo() { return $this->container['metaInfo']; } /** * Sets metaInfo * * @param object $metaInfo Meta data of product such as description, vendor, producer, stock level, etc. * * @return $this */ public function setMetaInfo($metaInfo) { $this->container['metaInfo'] = $metaInfo; return $this; } /** * Gets s3ThumbEditor * * @return string */ public function getS3ThumbEditor() { return $this->container['s3ThumbEditor']; } /** * Sets s3ThumbEditor * * @param string $s3ThumbEditor S3 thumbnail url of original image in 600x400 dimension for editor section * * @return $this */ public function setS3ThumbEditor($s3ThumbEditor) { $this->container['s3ThumbEditor'] = $s3ThumbEditor; return $this; } /** * Gets isDeleted * * @return bool */ public function getIsDeleted() { return $this->container['isDeleted']; } /** * Sets isDeleted * * @param bool $isDeleted product deleted from the shop's database * * @return $this */ public function setIsDeleted($isDeleted) { $this->container['isDeleted'] = $isDeleted; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/NoteData.php 0000644 00000023557 15021222673 0012500 0 ustar 00 <?php /** * NoteData * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * NoteData Class Doc Comment * * @category Class * @description Note data to be saved * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'NoteData'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'text' => 'string', 'contactIds' => 'int[]', 'dealIds' => 'string[]', 'companyIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'text' => null, 'contactIds' => null, 'dealIds' => null, 'companyIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'text' => 'text', 'contactIds' => 'contactIds', 'dealIds' => 'dealIds', 'companyIds' => 'companyIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'text' => 'setText', 'contactIds' => 'setContactIds', 'dealIds' => 'setDealIds', 'companyIds' => 'setCompanyIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'text' => 'getText', 'contactIds' => 'getContactIds', 'dealIds' => 'getDealIds', 'companyIds' => 'getCompanyIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['contactIds'] = isset($data['contactIds']) ? $data['contactIds'] : null; $this->container['dealIds'] = isset($data['dealIds']) ? $data['dealIds'] : null; $this->container['companyIds'] = isset($data['companyIds']) ? $data['companyIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } if ((mb_strlen($this->container['text']) > 3000)) { $invalidProperties[] = "invalid value for 'text', the character length must be smaller than or equal to 3000."; } if ((mb_strlen($this->container['text']) < 1)) { $invalidProperties[] = "invalid value for 'text', the character length must be bigger than or equal to 1."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text Text content of a note * * @return $this */ public function setText($text) { if ((mb_strlen($text) > 3000)) { throw new \InvalidArgumentException('invalid length for $text when calling NoteData., must be smaller than or equal to 3000.'); } if ((mb_strlen($text) < 1)) { throw new \InvalidArgumentException('invalid length for $text when calling NoteData., must be bigger than or equal to 1.'); } $this->container['text'] = $text; return $this; } /** * Gets contactIds * * @return int[] */ public function getContactIds() { return $this->container['contactIds']; } /** * Sets contactIds * * @param int[] $contactIds Contact Ids linked to a note * * @return $this */ public function setContactIds($contactIds) { $this->container['contactIds'] = $contactIds; return $this; } /** * Gets dealIds * * @return string[] */ public function getDealIds() { return $this->container['dealIds']; } /** * Sets dealIds * * @param string[] $dealIds Deal Ids linked to a note * * @return $this */ public function setDealIds($dealIds) { $this->container['dealIds'] = $dealIds; return $this; } /** * Gets companyIds * * @return string[] */ public function getCompanyIds() { return $this->container['companyIds']; } /** * Sets companyIds * * @param string[] $companyIds Company Ids linked to a note * * @return $this */ public function setCompanyIds($companyIds) { $this->container['companyIds'] = $companyIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateDomain.php 0000644 00000016040 15021222673 0013321 0 ustar 00 <?php /** * CreateDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Domain name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateEmailCampaignRecipients.php 0000644 00000021373 15021222673 0016634 0 ustar 00 <?php /** * CreateEmailCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateEmailCampaignRecipients Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createEmailCampaign_recipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'exclusionListIds' => 'int[]', 'listIds' => 'int[]', 'segmentIds' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'exclusionListIds' => 'int64', 'listIds' => 'int64', 'segmentIds' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'exclusionListIds' => 'exclusionListIds', 'listIds' => 'listIds', 'segmentIds' => 'segmentIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'exclusionListIds' => 'setExclusionListIds', 'listIds' => 'setListIds', 'segmentIds' => 'setSegmentIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'exclusionListIds' => 'getExclusionListIds', 'listIds' => 'getListIds', 'segmentIds' => 'getSegmentIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['exclusionListIds'] = isset($data['exclusionListIds']) ? $data['exclusionListIds'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['segmentIds'] = isset($data['segmentIds']) ? $data['segmentIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets exclusionListIds * * @return int[] */ public function getExclusionListIds() { return $this->container['exclusionListIds']; } /** * Sets exclusionListIds * * @param int[] $exclusionListIds List ids to exclude from the campaign * * @return $this */ public function setExclusionListIds($exclusionListIds) { $this->container['exclusionListIds'] = $exclusionListIds; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Mandatory if scheduledAt is not empty. List Ids to send the campaign to * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets segmentIds * * @return int[] */ public function getSegmentIds() { return $this->container['segmentIds']; } /** * Sets segmentIds * * @param int[] $segmentIds Mandatory if listIds are not used. Segment ids to send the campaign to. * * @return $this */ public function setSegmentIds($segmentIds) { $this->container['segmentIds'] = $segmentIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateAttribute.php 0000644 00000025657 15021222673 0014073 0 ustar 00 <?php /** * CreateAttribute * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateAttribute Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateAttribute implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createAttribute'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'value' => 'string', 'isRecurring' => 'bool', 'enumeration' => '\Brevo\Client\Model\CreateAttributeEnumeration[]', 'type' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'value' => null, 'isRecurring' => null, 'enumeration' => null, 'type' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'value' => 'value', 'isRecurring' => 'isRecurring', 'enumeration' => 'enumeration', 'type' => 'type' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'value' => 'setValue', 'isRecurring' => 'setIsRecurring', 'enumeration' => 'setEnumeration', 'type' => 'setType' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'value' => 'getValue', 'isRecurring' => 'getIsRecurring', 'enumeration' => 'getEnumeration', 'type' => 'getType' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_TEXT = 'text'; const TYPE_DATE = 'date'; const TYPE_FLOAT = 'float'; const TYPE_BOOLEAN = 'boolean'; const TYPE_ID = 'id'; const TYPE_CATEGORY = 'category'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_TEXT, self::TYPE_DATE, self::TYPE_FLOAT, self::TYPE_BOOLEAN, self::TYPE_ID, self::TYPE_CATEGORY, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['isRecurring'] = isset($data['isRecurring']) ? $data['isRecurring'] : null; $this->container['enumeration'] = isset($data['enumeration']) ? $data['enumeration'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets value * * @return string */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param string $value Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets isRecurring * * @return bool */ public function getIsRecurring() { return $this->container['isRecurring']; } /** * Sets isRecurring * * @param bool $isRecurring Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' * * @return $this */ public function setIsRecurring($isRecurring) { $this->container['isRecurring'] = $isRecurring; return $this; } /** * Gets enumeration * * @return \Brevo\Client\Model\CreateAttributeEnumeration[] */ public function getEnumeration() { return $this->container['enumeration']; } /** * Sets enumeration * * @param \Brevo\Client\Model\CreateAttributeEnumeration[] $enumeration List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] * * @return $this */ public function setEnumeration($enumeration) { $this->container['enumeration'] = $enumeration; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSenderIps.php 0000644 00000022520 15021222673 0014006 0 ustar 00 <?php /** * CreateSenderIps * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSenderIps Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSenderIps implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSender_ips'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'ip' => 'string', 'domain' => 'string', 'weight' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'ip' => null, 'domain' => null, 'weight' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'ip' => 'ip', 'domain' => 'domain', 'weight' => 'weight' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'ip' => 'setIp', 'domain' => 'setDomain', 'weight' => 'setWeight' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'ip' => 'getIp', 'domain' => 'getDomain', 'weight' => 'getWeight' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; $this->container['weight'] = isset($data['weight']) ? $data['weight'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } if (!is_null($this->container['weight']) && ($this->container['weight'] > 100)) { $invalidProperties[] = "invalid value for 'weight', must be smaller than or equal to 100."; } if (!is_null($this->container['weight']) && ($this->container['weight'] < 1)) { $invalidProperties[] = "invalid value for 'weight', must be bigger than or equal to 1."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip Dedicated IP available in your account * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Domain of the IP * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Gets weight * * @return int */ public function getWeight() { return $this->container['weight']; } /** * Sets weight * * @param int $weight Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. * * @return $this */ public function setWeight($weight) { if (!is_null($weight) && ($weight > 100)) { throw new \InvalidArgumentException('invalid value for $weight when calling CreateSenderIps., must be smaller than or equal to 100.'); } if (!is_null($weight) && ($weight < 1)) { throw new \InvalidArgumentException('invalid value for $weight when calling CreateSenderIps., must be bigger than or equal to 1.'); } $this->container['weight'] = $weight; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetStatsByBrowser.php 0000644 00000014677 15021222673 0014401 0 ustar 00 <?php /** * GetStatsByBrowser * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetStatsByBrowser Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByBrowser implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getStatsByBrowser'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body7.php 0000644 00000031675 15021222673 0011765 0 ustar 00 <?php /** * Body7 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body7 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body7 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_7'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'duration' => 'int', 'taskTypeId' => 'string', 'date' => '\DateTime', 'notes' => 'string', 'done' => 'bool', 'assignToId' => 'string', 'contactsIds' => 'int[]', 'dealsIds' => 'string[]', 'companiesIds' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'duration' => null, 'taskTypeId' => null, 'date' => 'date-time', 'notes' => null, 'done' => null, 'assignToId' => null, 'contactsIds' => null, 'dealsIds' => null, 'companiesIds' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'duration' => 'duration', 'taskTypeId' => 'taskTypeId', 'date' => 'date', 'notes' => 'notes', 'done' => 'done', 'assignToId' => 'assignToId', 'contactsIds' => 'contactsIds', 'dealsIds' => 'dealsIds', 'companiesIds' => 'companiesIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'duration' => 'setDuration', 'taskTypeId' => 'setTaskTypeId', 'date' => 'setDate', 'notes' => 'setNotes', 'done' => 'setDone', 'assignToId' => 'setAssignToId', 'contactsIds' => 'setContactsIds', 'dealsIds' => 'setDealsIds', 'companiesIds' => 'setCompaniesIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'duration' => 'getDuration', 'taskTypeId' => 'getTaskTypeId', 'date' => 'getDate', 'notes' => 'getNotes', 'done' => 'getDone', 'assignToId' => 'getAssignToId', 'contactsIds' => 'getContactsIds', 'dealsIds' => 'getDealsIds', 'companiesIds' => 'getCompaniesIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['duration'] = isset($data['duration']) ? $data['duration'] : null; $this->container['taskTypeId'] = isset($data['taskTypeId']) ? $data['taskTypeId'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['notes'] = isset($data['notes']) ? $data['notes'] : null; $this->container['done'] = isset($data['done']) ? $data['done'] : null; $this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null; $this->container['contactsIds'] = isset($data['contactsIds']) ? $data['contactsIds'] : null; $this->container['dealsIds'] = isset($data['dealsIds']) ? $data['dealsIds'] : null; $this->container['companiesIds'] = isset($data['companiesIds']) ? $data['companiesIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of task * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets duration * * @return int */ public function getDuration() { return $this->container['duration']; } /** * Sets duration * * @param int $duration Duration of task in milliseconds [1 minute = 60000 ms] * * @return $this */ public function setDuration($duration) { $this->container['duration'] = $duration; return $this; } /** * Gets taskTypeId * * @return string */ public function getTaskTypeId() { return $this->container['taskTypeId']; } /** * Sets taskTypeId * * @param string $taskTypeId Id for type of task e.g Call / Email / Meeting etc. * * @return $this */ public function setTaskTypeId($taskTypeId) { $this->container['taskTypeId'] = $taskTypeId; return $this; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Task date/time * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets notes * * @return string */ public function getNotes() { return $this->container['notes']; } /** * Sets notes * * @param string $notes Notes added to a task * * @return $this */ public function setNotes($notes) { $this->container['notes'] = $notes; return $this; } /** * Gets done * * @return bool */ public function getDone() { return $this->container['done']; } /** * Sets done * * @param bool $done Task marked as done * * @return $this */ public function setDone($done) { $this->container['done'] = $done; return $this; } /** * Gets assignToId * * @return string */ public function getAssignToId() { return $this->container['assignToId']; } /** * Sets assignToId * * @param string $assignToId User id to whom task is assigned * * @return $this */ public function setAssignToId($assignToId) { $this->container['assignToId'] = $assignToId; return $this; } /** * Gets contactsIds * * @return int[] */ public function getContactsIds() { return $this->container['contactsIds']; } /** * Sets contactsIds * * @param int[] $contactsIds Contact ids for contacts linked to this task * * @return $this */ public function setContactsIds($contactsIds) { $this->container['contactsIds'] = $contactsIds; return $this; } /** * Gets dealsIds * * @return string[] */ public function getDealsIds() { return $this->container['dealsIds']; } /** * Sets dealsIds * * @param string[] $dealsIds Deal ids for deals a task is linked to * * @return $this */ public function setDealsIds($dealsIds) { $this->container['dealsIds'] = $dealsIds; return $this; } /** * Gets companiesIds * * @return string[] */ public function getCompaniesIds() { return $this->container['companiesIds']; } /** * Sets companiesIds * * @param string[] $companiesIds Companies ids for companies a task is linked to * * @return $this */ public function setCompaniesIds($companiesIds) { $this->container['companiesIds'] = $companiesIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestCampaignResultStatistics.php 0000644 00000027442 15021222673 0017072 0 ustar 00 <?php /** * AbTestCampaignResultStatistics * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestCampaignResultStatistics Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResultStatistics implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestCampaignResult_statistics'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'openers' => '\Brevo\Client\Model\AbTestVersionStats', 'clicks' => '\Brevo\Client\Model\AbTestVersionStats', 'unsubscribed' => '\Brevo\Client\Model\AbTestVersionStats', 'hardBounces' => '\Brevo\Client\Model\AbTestVersionStats', 'softBounces' => '\Brevo\Client\Model\AbTestVersionStats', 'complaints' => '\Brevo\Client\Model\AbTestVersionStats' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'openers' => null, 'clicks' => null, 'unsubscribed' => null, 'hardBounces' => null, 'softBounces' => null, 'complaints' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'openers' => 'openers', 'clicks' => 'clicks', 'unsubscribed' => 'unsubscribed', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'complaints' => 'complaints' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'openers' => 'setOpeners', 'clicks' => 'setClicks', 'unsubscribed' => 'setUnsubscribed', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'complaints' => 'setComplaints' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'openers' => 'getOpeners', 'clicks' => 'getClicks', 'unsubscribed' => 'getUnsubscribed', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'complaints' => 'getComplaints' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['openers'] = isset($data['openers']) ? $data['openers'] : null; $this->container['clicks'] = isset($data['clicks']) ? $data['clicks'] : null; $this->container['unsubscribed'] = isset($data['unsubscribed']) ? $data['unsubscribed'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['complaints'] = isset($data['complaints']) ? $data['complaints'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['openers'] === null) { $invalidProperties[] = "'openers' can't be null"; } if ($this->container['clicks'] === null) { $invalidProperties[] = "'clicks' can't be null"; } if ($this->container['unsubscribed'] === null) { $invalidProperties[] = "'unsubscribed' can't be null"; } if ($this->container['hardBounces'] === null) { $invalidProperties[] = "'hardBounces' can't be null"; } if ($this->container['softBounces'] === null) { $invalidProperties[] = "'softBounces' can't be null"; } if ($this->container['complaints'] === null) { $invalidProperties[] = "'complaints' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets openers * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getOpeners() { return $this->container['openers']; } /** * Sets openers * * @param \Brevo\Client\Model\AbTestVersionStats $openers openers * * @return $this */ public function setOpeners($openers) { $this->container['openers'] = $openers; return $this; } /** * Gets clicks * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getClicks() { return $this->container['clicks']; } /** * Sets clicks * * @param \Brevo\Client\Model\AbTestVersionStats $clicks clicks * * @return $this */ public function setClicks($clicks) { $this->container['clicks'] = $clicks; return $this; } /** * Gets unsubscribed * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getUnsubscribed() { return $this->container['unsubscribed']; } /** * Sets unsubscribed * * @param \Brevo\Client\Model\AbTestVersionStats $unsubscribed unsubscribed * * @return $this */ public function setUnsubscribed($unsubscribed) { $this->container['unsubscribed'] = $unsubscribed; return $this; } /** * Gets hardBounces * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param \Brevo\Client\Model\AbTestVersionStats $hardBounces hardBounces * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param \Brevo\Client\Model\AbTestVersionStats $softBounces softBounces * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets complaints * * @return \Brevo\Client\Model\AbTestVersionStats */ public function getComplaints() { return $this->container['complaints']; } /** * Sets complaints * * @param \Brevo\Client\Model\AbTestVersionStats $complaints complaints * * @return $this */ public function setComplaints($complaints) { $this->container['complaints'] = $complaints; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetTransacSmsReportReports.php 0000644 00000032236 15021222673 0016264 0 ustar 00 <?php /** * GetTransacSmsReportReports * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetTransacSmsReportReports Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacSmsReportReports implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getTransacSmsReport_reports'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'date' => '\DateTime', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', 'softBounces' => 'int', 'blocked' => 'int', 'unsubscribed' => 'int', 'replied' => 'int', 'accepted' => 'int', 'rejected' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'date' => 'date', 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', 'softBounces' => 'int64', 'blocked' => 'int64', 'unsubscribed' => 'int64', 'replied' => 'int64', 'accepted' => 'int64', 'rejected' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'date' => 'date', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'blocked' => 'blocked', 'unsubscribed' => 'unsubscribed', 'replied' => 'replied', 'accepted' => 'accepted', 'rejected' => 'rejected' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'date' => 'setDate', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'blocked' => 'setBlocked', 'unsubscribed' => 'setUnsubscribed', 'replied' => 'setReplied', 'accepted' => 'setAccepted', 'rejected' => 'setRejected' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'date' => 'getDate', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'blocked' => 'getBlocked', 'unsubscribed' => 'getUnsubscribed', 'replied' => 'getReplied', 'accepted' => 'getAccepted', 'rejected' => 'getRejected' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['blocked'] = isset($data['blocked']) ? $data['blocked'] : null; $this->container['unsubscribed'] = isset($data['unsubscribed']) ? $data['unsubscribed'] : null; $this->container['replied'] = isset($data['replied']) ? $data['replied'] : null; $this->container['accepted'] = isset($data['accepted']) ? $data['accepted'] : null; $this->container['rejected'] = isset($data['rejected']) ? $data['rejected'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Date for which statistics are retrieved * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets requests * * @return int */ public function getRequests() { return $this->container['requests']; } /** * Sets requests * * @param int $requests Number of requests for the date * * @return $this */ public function setRequests($requests) { $this->container['requests'] = $requests; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered SMS for the date * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of hardbounces for the date * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounces for the date * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets blocked * * @return int */ public function getBlocked() { return $this->container['blocked']; } /** * Sets blocked * * @param int $blocked Number of blocked contact for the date * * @return $this */ public function setBlocked($blocked) { $this->container['blocked'] = $blocked; return $this; } /** * Gets unsubscribed * * @return int */ public function getUnsubscribed() { return $this->container['unsubscribed']; } /** * Sets unsubscribed * * @param int $unsubscribed Number of unsubscription for the date * * @return $this */ public function setUnsubscribed($unsubscribed) { $this->container['unsubscribed'] = $unsubscribed; return $this; } /** * Gets replied * * @return int */ public function getReplied() { return $this->container['replied']; } /** * Sets replied * * @param int $replied Number of answered SMS for the date * * @return $this */ public function setReplied($replied) { $this->container['replied'] = $replied; return $this; } /** * Gets accepted * * @return int */ public function getAccepted() { return $this->container['accepted']; } /** * Sets accepted * * @param int $accepted Number of accepted for the date * * @return $this */ public function setAccepted($accepted) { $this->container['accepted'] = $accepted; return $this; } /** * Gets rejected * * @return int */ public function getRejected() { return $this->container['rejected']; } /** * Sets rejected * * @param int $rejected Number of rejected for the date * * @return $this */ public function setRejected($rejected) { $this->container['rejected'] = $rejected; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ScheduleSmtpEmail.php 0000644 00000020663 15021222673 0014344 0 ustar 00 <?php /** * ScheduleSmtpEmail * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ScheduleSmtpEmail Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ScheduleSmtpEmail implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'scheduleSmtpEmail'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'messageId' => 'string', 'messageIds' => 'string[]', 'batchId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'messageId' => null, 'messageIds' => null, 'batchId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'messageId' => 'messageId', 'messageIds' => 'messageIds', 'batchId' => 'batchId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'messageId' => 'setMessageId', 'messageIds' => 'setMessageIds', 'batchId' => 'setBatchId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'messageId' => 'getMessageId', 'messageIds' => 'getMessageIds', 'batchId' => 'getBatchId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['messageIds'] = isset($data['messageIds']) ? $data['messageIds'] : null; $this->container['batchId'] = isset($data['batchId']) ? $data['batchId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message ID of the transactional email scheduled * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets messageIds * * @return string[] */ public function getMessageIds() { return $this->container['messageIds']; } /** * Sets messageIds * * @param string[] $messageIds messageIds * * @return $this */ public function setMessageIds($messageIds) { $this->container['messageIds'] = $messageIds; return $this; } /** * Gets batchId * * @return string */ public function getBatchId() { return $this->container['batchId']; } /** * Sets batchId * * @param string $batchId Batch ID of the batch transactional email scheduled * * @return $this */ public function setBatchId($batchId) { $this->container['batchId'] = $batchId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RemainingCreditModel.php 0000644 00000020124 15021222673 0015011 0 ustar 00 <?php /** * RemainingCreditModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RemainingCreditModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'remainingCreditModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'child' => '\Brevo\Client\Model\RemainingCreditModelChild', 'reseller' => '\Brevo\Client\Model\RemainingCreditModelReseller' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'child' => null, 'reseller' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'child' => 'child', 'reseller' => 'reseller' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'child' => 'setChild', 'reseller' => 'setReseller' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'child' => 'getChild', 'reseller' => 'getReseller' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['child'] = isset($data['child']) ? $data['child'] : null; $this->container['reseller'] = isset($data['reseller']) ? $data['reseller'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['child'] === null) { $invalidProperties[] = "'child' can't be null"; } if ($this->container['reseller'] === null) { $invalidProperties[] = "'reseller' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets child * * @return \Brevo\Client\Model\RemainingCreditModelChild */ public function getChild() { return $this->container['child']; } /** * Sets child * * @param \Brevo\Client\Model\RemainingCreditModelChild $child child * * @return $this */ public function setChild($child) { $this->container['child'] = $child; return $this; } /** * Gets reseller * * @return \Brevo\Client\Model\RemainingCreditModelReseller */ public function getReseller() { return $this->container['reseller']; } /** * Sets reseller * * @param \Brevo\Client\Model\RemainingCreditModelReseller $reseller reseller * * @return $this */ public function setReseller($reseller) { $this->container['reseller'] = $reseller; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInboundEmailEventsByUuid.php 0000644 00000030566 15021222673 0016314 0 ustar 00 <?php /** * GetInboundEmailEventsByUuid * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInboundEmailEventsByUuid Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuid implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInboundEmailEventsByUuid'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'receivedAt' => '\DateTime', 'deliveredAt' => '\DateTime', 'recipient' => 'string', 'sender' => 'string', 'messageId' => 'string', 'subject' => 'string', 'attachments' => '\Brevo\Client\Model\GetInboundEmailEventsByUuidAttachments[]', 'logs' => '\Brevo\Client\Model\GetInboundEmailEventsByUuidLogs[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'receivedAt' => 'date-time', 'deliveredAt' => 'date-time', 'recipient' => 'email', 'sender' => 'email', 'messageId' => null, 'subject' => null, 'attachments' => null, 'logs' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'receivedAt' => 'receivedAt', 'deliveredAt' => 'deliveredAt', 'recipient' => 'recipient', 'sender' => 'sender', 'messageId' => 'messageId', 'subject' => 'subject', 'attachments' => 'attachments', 'logs' => 'logs' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'receivedAt' => 'setReceivedAt', 'deliveredAt' => 'setDeliveredAt', 'recipient' => 'setRecipient', 'sender' => 'setSender', 'messageId' => 'setMessageId', 'subject' => 'setSubject', 'attachments' => 'setAttachments', 'logs' => 'setLogs' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'receivedAt' => 'getReceivedAt', 'deliveredAt' => 'getDeliveredAt', 'recipient' => 'getRecipient', 'sender' => 'getSender', 'messageId' => 'getMessageId', 'subject' => 'getSubject', 'attachments' => 'getAttachments', 'logs' => 'getLogs' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['receivedAt'] = isset($data['receivedAt']) ? $data['receivedAt'] : null; $this->container['deliveredAt'] = isset($data['deliveredAt']) ? $data['deliveredAt'] : null; $this->container['recipient'] = isset($data['recipient']) ? $data['recipient'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['attachments'] = isset($data['attachments']) ? $data['attachments'] : null; $this->container['logs'] = isset($data['logs']) ? $data['logs'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets receivedAt * * @return \DateTime */ public function getReceivedAt() { return $this->container['receivedAt']; } /** * Sets receivedAt * * @param \DateTime $receivedAt Date when email was received on SMTP relay * * @return $this */ public function setReceivedAt($receivedAt) { $this->container['receivedAt'] = $receivedAt; return $this; } /** * Gets deliveredAt * * @return \DateTime */ public function getDeliveredAt() { return $this->container['deliveredAt']; } /** * Sets deliveredAt * * @param \DateTime $deliveredAt Date when email was delivered successfully to client’s webhook * * @return $this */ public function setDeliveredAt($deliveredAt) { $this->container['deliveredAt'] = $deliveredAt; return $this; } /** * Gets recipient * * @return string */ public function getRecipient() { return $this->container['recipient']; } /** * Sets recipient * * @param string $recipient Recipient’s email address * * @return $this */ public function setRecipient($recipient) { $this->container['recipient'] = $recipient; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Sender’s email address * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Value of the Message-ID header. This will be present only after the processing is done. * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Value of the Subject header. This will be present only after the processing is done. * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets attachments * * @return \Brevo\Client\Model\GetInboundEmailEventsByUuidAttachments[] */ public function getAttachments() { return $this->container['attachments']; } /** * Sets attachments * * @param \Brevo\Client\Model\GetInboundEmailEventsByUuidAttachments[] $attachments List of attachments of the email. This will be present only after the processing is done. * * @return $this */ public function setAttachments($attachments) { $this->container['attachments'] = $attachments; return $this; } /** * Gets logs * * @return \Brevo\Client\Model\GetInboundEmailEventsByUuidLogs[] */ public function getLogs() { return $this->container['logs']; } /** * Sets logs * * @param \Brevo\Client\Model\GetInboundEmailEventsByUuidLogs[] $logs List of events/logs that describe the lifecycle of the email on SIB platform * * @return $this */ public function setLogs($logs) { $this->container['logs'] = $logs; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCategoryDetails.php 0000644 00000025404 15021222673 0014515 0 ustar 00 <?php /** * GetCategoryDetails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCategoryDetails Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCategoryDetails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCategoryDetails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'url' => 'string', 'isDeleted' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'string', 'name' => 'string', 'createdAt' => null, 'modifiedAt' => null, 'url' => 'string', 'isDeleted' => 'string' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'url' => 'url', 'isDeleted' => 'isDeleted' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'url' => 'setUrl', 'isDeleted' => 'setIsDeleted' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'url' => 'getUrl', 'isDeleted' => 'getIsDeleted' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['isDeleted'] = isset($data['isDeleted']) ? $data['isDeleted'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Category ID for which you requested the details * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the category for which you requested the details * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the category * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets isDeleted * * @return bool */ public function getIsDeleted() { return $this->container['isDeleted']; } /** * Sets isDeleted * * @param bool $isDeleted category deleted from the shop's database * * @return $this */ public function setIsDeleted($isDeleted) { $this->container['isDeleted'] = $isDeleted; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/PostContactInfoContacts.php 0000644 00000022075 15021222673 0015547 0 ustar 00 <?php /** * PostContactInfoContacts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * PostContactInfoContacts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostContactInfoContacts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'postContactInfo_contacts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'success' => 'string[]', 'failure' => 'string[]', 'total' => 'int', 'processId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'success' => 'email', 'failure' => 'email', 'total' => 'int64', 'processId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'success' => 'success', 'failure' => 'failure', 'total' => 'total', 'processId' => 'processId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'success' => 'setSuccess', 'failure' => 'setFailure', 'total' => 'setTotal', 'processId' => 'setProcessId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'success' => 'getSuccess', 'failure' => 'getFailure', 'total' => 'getTotal', 'processId' => 'getProcessId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['success'] = isset($data['success']) ? $data['success'] : null; $this->container['failure'] = isset($data['failure']) ? $data['failure'] : null; $this->container['total'] = isset($data['total']) ? $data['total'] : null; $this->container['processId'] = isset($data['processId']) ? $data['processId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets success * * @return string[] */ public function getSuccess() { return $this->container['success']; } /** * Sets success * * @param string[] $success success * * @return $this */ public function setSuccess($success) { $this->container['success'] = $success; return $this; } /** * Gets failure * * @return string[] */ public function getFailure() { return $this->container['failure']; } /** * Sets failure * * @param string[] $failure failure * * @return $this */ public function setFailure($failure) { $this->container['failure'] = $failure; return $this; } /** * Gets total * * @return int */ public function getTotal() { return $this->container['total']; } /** * Sets total * * @param int $total Displays the count of total number of contacts removed from list when user opts for \"all\" option. * * @return $this */ public function setTotal($total) { $this->container['total'] = $total; return $this; } /** * Gets processId * * @return int */ public function getProcessId() { return $this->container['processId']; } /** * Sets processId * * @param int $processId Id of the process created to remove contacts from list when user opts for \"all\" option. * * @return $this */ public function setProcessId($processId) { $this->container['processId'] = $processId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetScheduledEmailByBatchIdBatches.php 0000644 00000024100 15021222673 0017276 0 ustar 00 <?php /** * GetScheduledEmailByBatchIdBatches * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetScheduledEmailByBatchIdBatches Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByBatchIdBatches implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getScheduledEmailByBatchId_batches'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'scheduledAt' => '\DateTime', 'createdAt' => '\DateTime', 'status' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'scheduledAt' => 'date-time', 'createdAt' => 'date-time', 'status' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'scheduledAt' => 'scheduledAt', 'createdAt' => 'createdAt', 'status' => 'status' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'scheduledAt' => 'setScheduledAt', 'createdAt' => 'setCreatedAt', 'status' => 'setStatus' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'scheduledAt' => 'getScheduledAt', 'createdAt' => 'getCreatedAt', 'status' => 'getStatus' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_IN_PROGRESS = 'inProgress'; const STATUS_QUEUED = 'queued'; const STATUS_PROCESSED = 'processed'; const STATUS_ERROR = 'error'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_IN_PROGRESS, self::STATUS_QUEUED, self::STATUS_PROCESSED, self::STATUS_ERROR, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['scheduledAt'] === null) { $invalidProperties[] = "'scheduledAt' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets scheduledAt * * @return \DateTime */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param \DateTime $scheduledAt Datetime for which the batch was scheduled * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Datetime on which the batch was scheduled * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Current status of the scheduled batch * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountUpdatePlanRequest.php 0000644 00000020006 15021222673 0016360 0 ustar 00 <?php /** * SubAccountUpdatePlanRequest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountUpdatePlanRequest Class Doc Comment * * @category Class * @description Details of the plan to be changed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountUpdatePlanRequest'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'credits' => '\Brevo\Client\Model\SubAccountUpdatePlanRequestCredits', 'features' => '\Brevo\Client\Model\SubAccountUpdatePlanRequestFeatures' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'credits' => null, 'features' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'credits' => 'credits', 'features' => 'features' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'credits' => 'setCredits', 'features' => 'setFeatures' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'credits' => 'getCredits', 'features' => 'getFeatures' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['credits'] = isset($data['credits']) ? $data['credits'] : null; $this->container['features'] = isset($data['features']) ? $data['features'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets credits * * @return \Brevo\Client\Model\SubAccountUpdatePlanRequestCredits */ public function getCredits() { return $this->container['credits']; } /** * Sets credits * * @param \Brevo\Client\Model\SubAccountUpdatePlanRequestCredits $credits credits * * @return $this */ public function setCredits($credits) { $this->container['credits'] = $credits; return $this; } /** * Gets features * * @return \Brevo\Client\Model\SubAccountUpdatePlanRequestFeatures */ public function getFeatures() { return $this->container['features']; } /** * Sets features * * @param \Brevo\Client\Model\SubAccountUpdatePlanRequestFeatures $features features * * @return $this */ public function setFeatures($features) { $this->container['features'] = $features; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestCampaignResultClickedLinks.php 0000644 00000020237 15021222673 0017272 0 ustar 00 <?php /** * AbTestCampaignResultClickedLinks * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestCampaignResultClickedLinks Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResultClickedLinks implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestCampaignResult_clickedLinks'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'versionA' => '\Brevo\Client\Model\AbTestVersionClicks', 'versionB' => '\Brevo\Client\Model\AbTestVersionClicks' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'versionA' => null, 'versionB' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'versionA' => 'Version A', 'versionB' => 'Version B' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'versionA' => 'setVersionA', 'versionB' => 'setVersionB' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'versionA' => 'getVersionA', 'versionB' => 'getVersionB' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['versionA'] = isset($data['versionA']) ? $data['versionA'] : null; $this->container['versionB'] = isset($data['versionB']) ? $data['versionB'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['versionA'] === null) { $invalidProperties[] = "'versionA' can't be null"; } if ($this->container['versionB'] === null) { $invalidProperties[] = "'versionB' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets versionA * * @return \Brevo\Client\Model\AbTestVersionClicks */ public function getVersionA() { return $this->container['versionA']; } /** * Sets versionA * * @param \Brevo\Client\Model\AbTestVersionClicks $versionA versionA * * @return $this */ public function setVersionA($versionA) { $this->container['versionA'] = $versionA; return $this; } /** * Gets versionB * * @return \Brevo\Client\Model\AbTestVersionClicks */ public function getVersionB() { return $this->container['versionB']; } /** * Sets versionB * * @param \Brevo\Client\Model\AbTestVersionClicks $versionB versionB * * @return $this */ public function setVersionB($versionB) { $this->container['versionB'] = $versionB; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsOpened.php 0000644 00000023002 15021222673 0021212 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsOpened * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsOpened Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsOpened implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_opened'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'count' => 'int', 'eventTime' => 'string', 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'count' => 'int64', 'eventTime' => null, 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'count' => 'count', 'eventTime' => 'eventTime', 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'count' => 'setCount', 'eventTime' => 'setEventTime', 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'count' => 'getCount', 'eventTime' => 'getEventTime', 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of openings for the campaign * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has opened the email * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse201.php 0000644 00000016055 15021222673 0014154 0 ustar 00 <?php /** * InlineResponse201 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse201 Class Doc Comment * * @category Class * @description Created deal id * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse201 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_201'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique deal id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/WhatsappCampStats.php 0000644 00000024056 15021222673 0014403 0 ustar 00 <?php /** * WhatsappCampStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * WhatsappCampStats Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsappCampStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'WhatsappCampStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sent' => 'int', 'delivered' => 'int', 'read' => 'int', 'unsubscribe' => 'int', 'notSent' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sent' => null, 'delivered' => null, 'read' => null, 'unsubscribe' => null, 'notSent' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sent' => 'sent', 'delivered' => 'delivered', 'read' => 'read', 'unsubscribe' => 'unsubscribe', 'notSent' => 'not_sent' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sent' => 'setSent', 'delivered' => 'setDelivered', 'read' => 'setRead', 'unsubscribe' => 'setUnsubscribe', 'notSent' => 'setNotSent' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sent' => 'getSent', 'delivered' => 'getDelivered', 'read' => 'getRead', 'unsubscribe' => 'getUnsubscribe', 'notSent' => 'getNotSent' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sent'] = isset($data['sent']) ? $data['sent'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['read'] = isset($data['read']) ? $data['read'] : null; $this->container['unsubscribe'] = isset($data['unsubscribe']) ? $data['unsubscribe'] : null; $this->container['notSent'] = isset($data['notSent']) ? $data['notSent'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['sent'] === null) { $invalidProperties[] = "'sent' can't be null"; } if ($this->container['delivered'] === null) { $invalidProperties[] = "'delivered' can't be null"; } if ($this->container['read'] === null) { $invalidProperties[] = "'read' can't be null"; } if ($this->container['unsubscribe'] === null) { $invalidProperties[] = "'unsubscribe' can't be null"; } if ($this->container['notSent'] === null) { $invalidProperties[] = "'notSent' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sent * * @return int */ public function getSent() { return $this->container['sent']; } /** * Sets sent * * @param int $sent sent * * @return $this */ public function setSent($sent) { $this->container['sent'] = $sent; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered delivered * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets read * * @return int */ public function getRead() { return $this->container['read']; } /** * Sets read * * @param int $read read * * @return $this */ public function setRead($read) { $this->container['read'] = $read; return $this; } /** * Gets unsubscribe * * @return int */ public function getUnsubscribe() { return $this->container['unsubscribe']; } /** * Sets unsubscribe * * @param int $unsubscribe unsubscribe * * @return $this */ public function setUnsubscribe($unsubscribe) { $this->container['unsubscribe'] = $unsubscribe; return $this; } /** * Gets notSent * * @return int */ public function getNotSent() { return $this->container['notSent']; } /** * Sets notSent * * @param int $notSent notSent * * @return $this */ public function setNotSent($notSent) { $this->container['notSent'] = $notSent; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/FileData.php 0000644 00000031643 15021222673 0012445 0 ustar 00 <?php /** * FileData * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * FileData Class Doc Comment * * @category Class * @description File data that is uploaded * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'FileData'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string', 'id' => 'string', 'name' => 'string', 'authorId' => 'string', 'author' => 'object', 'contactId' => 'int', 'dealId' => 'string', 'companyId' => 'string', 'size' => 'int', 'createdAt' => '\DateTime', 'updatedAt' => '\DateTime' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => null, 'id' => null, 'name' => null, 'authorId' => null, 'author' => null, 'contactId' => 'int64', 'dealId' => null, 'companyId' => null, 'size' => 'int64', 'createdAt' => 'date-time', 'updatedAt' => 'date-time' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url', 'id' => 'id', 'name' => 'name', 'authorId' => 'authorId', 'author' => 'author', 'contactId' => 'contactId', 'dealId' => 'dealId', 'companyId' => 'companyId', 'size' => 'size', 'createdAt' => 'createdAt', 'updatedAt' => 'updatedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl', 'id' => 'setId', 'name' => 'setName', 'authorId' => 'setAuthorId', 'author' => 'setAuthor', 'contactId' => 'setContactId', 'dealId' => 'setDealId', 'companyId' => 'setCompanyId', 'size' => 'setSize', 'createdAt' => 'setCreatedAt', 'updatedAt' => 'setUpdatedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl', 'id' => 'getId', 'name' => 'getName', 'authorId' => 'getAuthorId', 'author' => 'getAuthor', 'contactId' => 'getContactId', 'dealId' => 'getDealId', 'companyId' => 'getCompanyId', 'size' => 'getSize', 'createdAt' => 'getCreatedAt', 'updatedAt' => 'getUpdatedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['authorId'] = isset($data['authorId']) ? $data['authorId'] : null; $this->container['author'] = isset($data['author']) ? $data['author'] : null; $this->container['contactId'] = isset($data['contactId']) ? $data['contactId'] : null; $this->container['dealId'] = isset($data['dealId']) ? $data['dealId'] : null; $this->container['companyId'] = isset($data['companyId']) ? $data['companyId'] : null; $this->container['size'] = isset($data['size']) ? $data['size'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url Url of uploaded file * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Id of uploaded file * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of uploaded file * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets authorId * * @return string */ public function getAuthorId() { return $this->container['authorId']; } /** * Sets authorId * * @param string $authorId Account id of user which created the file * * @return $this */ public function setAuthorId($authorId) { $this->container['authorId'] = $authorId; return $this; } /** * Gets contactId * * @return int */ public function getContactId() { return $this->container['contactId']; } /** * Sets contactId * * @param int $contactId Contact id of contact on which file is uploaded * * @return $this */ public function setContactId($contactId) { $this->container['contactId'] = $contactId; return $this; } /** * Gets dealId * * @return string */ public function getDealId() { return $this->container['dealId']; } /** * Sets dealId * * @param string $dealId Deal id linked to a file * * @return $this */ public function setDealId($dealId) { $this->container['dealId'] = $dealId; return $this; } /** * Gets companyId * * @return string */ public function getCompanyId() { return $this->container['companyId']; } /** * Sets companyId * * @param string $companyId Company id linked to a file * * @return $this */ public function setCompanyId($companyId) { $this->container['companyId'] = $companyId; return $this; } /** * Gets size * * @return int */ public function getSize() { return $this->container['size']; } /** * Sets size * * @param int $size Size of file in bytes * * @return $this */ public function setSize($size) { $this->container['size'] = $size; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt File created date/time * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets updatedAt * * @return \DateTime */ public function getUpdatedAt() { return $this->container['updatedAt']; } /** * Sets updatedAt * * @param \DateTime $updatedAt File updated date/time * * @return $this */ public function setUpdatedAt($updatedAt) { $this->container['updatedAt'] = $updatedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsDelivered.php 0000644 00000020006 15021222673 0021704 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsDelivered * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsDelivered Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsDelivered implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_delivered'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'eventTime' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'eventTime' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'eventTime' => 'eventTime' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'eventTime' => 'setEventTime' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'eventTime' => 'getEventTime' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAttributes.php 0000644 00000016511 15021222673 0013557 0 ustar 00 <?php /** * GetAttributes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAttributes Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAttributes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'attributes' => '\Brevo\Client\Model\GetAttributesAttributes[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'attributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'attributes' => 'attributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'attributes' => 'setAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'attributes' => 'getAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['attributes'] === null) { $invalidProperties[] = "'attributes' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets attributes * * @return \Brevo\Client\Model\GetAttributesAttributes[] */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param \Brevo\Client\Model\GetAttributesAttributes[] $attributes Listing of available contact attributes in your account * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateWhatsAppCampaignRecipients.php 0000644 00000021323 15021222673 0017327 0 ustar 00 <?php /** * CreateWhatsAppCampaignRecipients * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateWhatsAppCampaignRecipients Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppCampaignRecipients implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createWhatsAppCampaign_recipients'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'excludedListIds' => 'int[]', 'listIds' => 'int[]', 'segments' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'excludedListIds' => 'int64', 'listIds' => 'int64', 'segments' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'excludedListIds' => 'excludedListIds', 'listIds' => 'listIds', 'segments' => 'segments' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'excludedListIds' => 'setExcludedListIds', 'listIds' => 'setListIds', 'segments' => 'setSegments' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'excludedListIds' => 'getExcludedListIds', 'listIds' => 'getListIds', 'segments' => 'getSegments' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['excludedListIds'] = isset($data['excludedListIds']) ? $data['excludedListIds'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['segments'] = isset($data['segments']) ? $data['segments'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets excludedListIds * * @return int[] */ public function getExcludedListIds() { return $this->container['excludedListIds']; } /** * Sets excludedListIds * * @param int[] $excludedListIds List ids to exclude from the campaign * * @return $this */ public function setExcludedListIds($excludedListIds) { $this->container['excludedListIds'] = $excludedListIds; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets segments * * @return int[] */ public function getSegments() { return $this->container['segments']; } /** * Sets segments * * @param int[] $segments **Mandatory if listIds are not used**. Segment ids to send the campaign to. * * @return $this */ public function setSegments($segments) { $this->container['segments'] = $segments; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountAppsToggleRequest.php 0000644 00000040302 15021222673 0016371 0 ustar 00 <?php /** * SubAccountAppsToggleRequest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountAppsToggleRequest Class Doc Comment * * @category Class * @description List of enable/disable applications on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountAppsToggleRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountAppsToggleRequest'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'inbox' => 'bool', 'whatsapp' => 'bool', 'automation' => 'bool', 'emailCampaigns' => 'bool', 'smsCampaigns' => 'bool', 'landingPages' => 'bool', 'transactionalEmails' => 'bool', 'transactionalSms' => 'bool', 'facebookAds' => 'bool', 'webPush' => 'bool', 'meetings' => 'bool', 'conversations' => 'bool', 'crm' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'inbox' => null, 'whatsapp' => null, 'automation' => null, 'emailCampaigns' => null, 'smsCampaigns' => null, 'landingPages' => null, 'transactionalEmails' => null, 'transactionalSms' => null, 'facebookAds' => null, 'webPush' => null, 'meetings' => null, 'conversations' => null, 'crm' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'inbox' => 'inbox', 'whatsapp' => 'whatsapp', 'automation' => 'automation', 'emailCampaigns' => 'email-campaigns', 'smsCampaigns' => 'sms-campaigns', 'landingPages' => 'landing-pages', 'transactionalEmails' => 'transactional-emails', 'transactionalSms' => 'transactional-sms', 'facebookAds' => 'facebook-ads', 'webPush' => 'web-push', 'meetings' => 'meetings', 'conversations' => 'conversations', 'crm' => 'crm' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'inbox' => 'setInbox', 'whatsapp' => 'setWhatsapp', 'automation' => 'setAutomation', 'emailCampaigns' => 'setEmailCampaigns', 'smsCampaigns' => 'setSmsCampaigns', 'landingPages' => 'setLandingPages', 'transactionalEmails' => 'setTransactionalEmails', 'transactionalSms' => 'setTransactionalSms', 'facebookAds' => 'setFacebookAds', 'webPush' => 'setWebPush', 'meetings' => 'setMeetings', 'conversations' => 'setConversations', 'crm' => 'setCrm' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'inbox' => 'getInbox', 'whatsapp' => 'getWhatsapp', 'automation' => 'getAutomation', 'emailCampaigns' => 'getEmailCampaigns', 'smsCampaigns' => 'getSmsCampaigns', 'landingPages' => 'getLandingPages', 'transactionalEmails' => 'getTransactionalEmails', 'transactionalSms' => 'getTransactionalSms', 'facebookAds' => 'getFacebookAds', 'webPush' => 'getWebPush', 'meetings' => 'getMeetings', 'conversations' => 'getConversations', 'crm' => 'getCrm' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['inbox'] = isset($data['inbox']) ? $data['inbox'] : null; $this->container['whatsapp'] = isset($data['whatsapp']) ? $data['whatsapp'] : null; $this->container['automation'] = isset($data['automation']) ? $data['automation'] : null; $this->container['emailCampaigns'] = isset($data['emailCampaigns']) ? $data['emailCampaigns'] : null; $this->container['smsCampaigns'] = isset($data['smsCampaigns']) ? $data['smsCampaigns'] : null; $this->container['landingPages'] = isset($data['landingPages']) ? $data['landingPages'] : null; $this->container['transactionalEmails'] = isset($data['transactionalEmails']) ? $data['transactionalEmails'] : null; $this->container['transactionalSms'] = isset($data['transactionalSms']) ? $data['transactionalSms'] : null; $this->container['facebookAds'] = isset($data['facebookAds']) ? $data['facebookAds'] : null; $this->container['webPush'] = isset($data['webPush']) ? $data['webPush'] : null; $this->container['meetings'] = isset($data['meetings']) ? $data['meetings'] : null; $this->container['conversations'] = isset($data['conversations']) ? $data['conversations'] : null; $this->container['crm'] = isset($data['crm']) ? $data['crm'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets inbox * * @return bool */ public function getInbox() { return $this->container['inbox']; } /** * Sets inbox * * @param bool $inbox Set this field to enable or disable Inbox on the sub-account * * @return $this */ public function setInbox($inbox) { $this->container['inbox'] = $inbox; return $this; } /** * Gets whatsapp * * @return bool */ public function getWhatsapp() { return $this->container['whatsapp']; } /** * Sets whatsapp * * @param bool $whatsapp Set this field to enable or disable Whatsapp campaigns on the sub-account * * @return $this */ public function setWhatsapp($whatsapp) { $this->container['whatsapp'] = $whatsapp; return $this; } /** * Gets automation * * @return bool */ public function getAutomation() { return $this->container['automation']; } /** * Sets automation * * @param bool $automation Set this field to enable or disable Automation on the sub-account * * @return $this */ public function setAutomation($automation) { $this->container['automation'] = $automation; return $this; } /** * Gets emailCampaigns * * @return bool */ public function getEmailCampaigns() { return $this->container['emailCampaigns']; } /** * Sets emailCampaigns * * @param bool $emailCampaigns Set this field to enable or disable Email Campaigns on the sub-account * * @return $this */ public function setEmailCampaigns($emailCampaigns) { $this->container['emailCampaigns'] = $emailCampaigns; return $this; } /** * Gets smsCampaigns * * @return bool */ public function getSmsCampaigns() { return $this->container['smsCampaigns']; } /** * Sets smsCampaigns * * @param bool $smsCampaigns Set this field to enable or disable SMS Marketing on the sub-account * * @return $this */ public function setSmsCampaigns($smsCampaigns) { $this->container['smsCampaigns'] = $smsCampaigns; return $this; } /** * Gets landingPages * * @return bool */ public function getLandingPages() { return $this->container['landingPages']; } /** * Sets landingPages * * @param bool $landingPages Set this field to enable or disable Landing pages on the sub-account * * @return $this */ public function setLandingPages($landingPages) { $this->container['landingPages'] = $landingPages; return $this; } /** * Gets transactionalEmails * * @return bool */ public function getTransactionalEmails() { return $this->container['transactionalEmails']; } /** * Sets transactionalEmails * * @param bool $transactionalEmails Set this field to enable or disable Transactional Email on the sub-account * * @return $this */ public function setTransactionalEmails($transactionalEmails) { $this->container['transactionalEmails'] = $transactionalEmails; return $this; } /** * Gets transactionalSms * * @return bool */ public function getTransactionalSms() { return $this->container['transactionalSms']; } /** * Sets transactionalSms * * @param bool $transactionalSms Set this field to enable or disable Transactional SMS on the sub-account * * @return $this */ public function setTransactionalSms($transactionalSms) { $this->container['transactionalSms'] = $transactionalSms; return $this; } /** * Gets facebookAds * * @return bool */ public function getFacebookAds() { return $this->container['facebookAds']; } /** * Sets facebookAds * * @param bool $facebookAds Set this field to enable or disable Facebook ads on the sub-account * * @return $this */ public function setFacebookAds($facebookAds) { $this->container['facebookAds'] = $facebookAds; return $this; } /** * Gets webPush * * @return bool */ public function getWebPush() { return $this->container['webPush']; } /** * Sets webPush * * @param bool $webPush Set this field to enable or disable Web Push on the sub-account * * @return $this */ public function setWebPush($webPush) { $this->container['webPush'] = $webPush; return $this; } /** * Gets meetings * * @return bool */ public function getMeetings() { return $this->container['meetings']; } /** * Sets meetings * * @param bool $meetings Set this field to enable or disable Meetings on the sub-account * * @return $this */ public function setMeetings($meetings) { $this->container['meetings'] = $meetings; return $this; } /** * Gets conversations * * @return bool */ public function getConversations() { return $this->container['conversations']; } /** * Sets conversations * * @param bool $conversations Set this field to enable or disable Conversations on the sub-account * * @return $this */ public function setConversations($conversations) { $this->container['conversations'] = $conversations; return $this; } /** * Gets crm * * @return bool */ public function getCrm() { return $this->container['crm']; } /** * Sets crm * * @param bool $crm Set this field to enable or disable Sales CRM on the sub-account * * @return $this */ public function setCrm($crm) { $this->container['crm'] = $crm; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponsePlanInfoFeatures.php 0000644 00000023171 15021222673 0020377 0 ustar 00 <?php /** * MasterDetailsResponsePlanInfoFeatures * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponsePlanInfoFeatures Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponsePlanInfoFeatures implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse_planInfo_features'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'unitValue' => 'string', 'quantity' => 'int', 'used' => 'int', 'remaining' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'unitValue' => null, 'quantity' => 'int64', 'used' => 'int64', 'remaining' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'unitValue' => 'unitValue', 'quantity' => 'quantity', 'used' => 'used', 'remaining' => 'remaining' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'unitValue' => 'setUnitValue', 'quantity' => 'setQuantity', 'used' => 'setUsed', 'remaining' => 'setRemaining' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'unitValue' => 'getUnitValue', 'quantity' => 'getQuantity', 'used' => 'getUsed', 'remaining' => 'getRemaining' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['unitValue'] = isset($data['unitValue']) ? $data['unitValue'] : null; $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['used'] = isset($data['used']) ? $data['used'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the feature * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets unitValue * * @return string */ public function getUnitValue() { return $this->container['unitValue']; } /** * Sets unitValue * * @param string $unitValue Unit value of the feature * * @return $this */ public function setUnitValue($unitValue) { $this->container['unitValue'] = $unitValue; return $this; } /** * Gets quantity * * @return int */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param int $quantity Quantity provided in the plan * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets used * * @return int */ public function getUsed() { return $this->container['used']; } /** * Sets used * * @param int $used Quantity consumed by master * * @return $this */ public function setUsed($used) { $this->container['used'] = $used; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Quantity remaining in the plan * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateSender.php 0000644 00000020435 15021222673 0013354 0 ustar 00 <?php /** * UpdateSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateSender Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateSender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'ips' => '\Brevo\Client\Model\CreateSenderIps[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'ips' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'ips' => 'ips' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'ips' => 'setIps' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'ips' => 'getIps' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name From Name to update the sender * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email From Email to update the sender * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets ips * * @return \Brevo\Client\Model\CreateSenderIps[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param \Brevo\Client\Model\CreateSenderIps[] $ips Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetDomainsList.php 0000644 00000016177 15021222673 0013667 0 ustar 00 <?php /** * GetDomainsList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetDomainsList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainsList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getDomainsList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domains' => '\Brevo\Client\Model\GetDomainsListDomains[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domains' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domains' => 'domains' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domains' => 'setDomains' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domains' => 'getDomains' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domains'] = isset($data['domains']) ? $data['domains'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domains * * @return \Brevo\Client\Model\GetDomainsListDomains[] */ public function getDomains() { return $this->container['domains']; } /** * Sets domains * * @param \Brevo\Client\Model\GetDomainsListDomains[] $domains List of the domains available in your account * * @return $this */ public function setDomains($domains) { $this->container['domains'] = $domains; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body.php 0000644 00000034651 15021222673 0011673 0 ustar 00 <?php /** * Body * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'duration' => 'int', 'taskTypeId' => 'string', 'date' => '\DateTime', 'notes' => 'string', 'done' => 'bool', 'assignToId' => 'string', 'contactsIds' => 'int[]', 'dealsIds' => 'string[]', 'companiesIds' => 'string[]', 'reminder' => '\Brevo\Client\Model\TaskReminder' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'duration' => 'int64', 'taskTypeId' => null, 'date' => 'date-time', 'notes' => null, 'done' => null, 'assignToId' => null, 'contactsIds' => null, 'dealsIds' => null, 'companiesIds' => null, 'reminder' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'duration' => 'duration', 'taskTypeId' => 'taskTypeId', 'date' => 'date', 'notes' => 'notes', 'done' => 'done', 'assignToId' => 'assignToId', 'contactsIds' => 'contactsIds', 'dealsIds' => 'dealsIds', 'companiesIds' => 'companiesIds', 'reminder' => 'reminder' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'duration' => 'setDuration', 'taskTypeId' => 'setTaskTypeId', 'date' => 'setDate', 'notes' => 'setNotes', 'done' => 'setDone', 'assignToId' => 'setAssignToId', 'contactsIds' => 'setContactsIds', 'dealsIds' => 'setDealsIds', 'companiesIds' => 'setCompaniesIds', 'reminder' => 'setReminder' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'duration' => 'getDuration', 'taskTypeId' => 'getTaskTypeId', 'date' => 'getDate', 'notes' => 'getNotes', 'done' => 'getDone', 'assignToId' => 'getAssignToId', 'contactsIds' => 'getContactsIds', 'dealsIds' => 'getDealsIds', 'companiesIds' => 'getCompaniesIds', 'reminder' => 'getReminder' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['duration'] = isset($data['duration']) ? $data['duration'] : null; $this->container['taskTypeId'] = isset($data['taskTypeId']) ? $data['taskTypeId'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['notes'] = isset($data['notes']) ? $data['notes'] : null; $this->container['done'] = isset($data['done']) ? $data['done'] : null; $this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null; $this->container['contactsIds'] = isset($data['contactsIds']) ? $data['contactsIds'] : null; $this->container['dealsIds'] = isset($data['dealsIds']) ? $data['dealsIds'] : null; $this->container['companiesIds'] = isset($data['companiesIds']) ? $data['companiesIds'] : null; $this->container['reminder'] = isset($data['reminder']) ? $data['reminder'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if (!is_null($this->container['duration']) && ($this->container['duration'] < 0)) { $invalidProperties[] = "invalid value for 'duration', must be bigger than or equal to 0."; } if ($this->container['taskTypeId'] === null) { $invalidProperties[] = "'taskTypeId' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of task * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets duration * * @return int */ public function getDuration() { return $this->container['duration']; } /** * Sets duration * * @param int $duration Duration of task in milliseconds [1 minute = 60000 ms] * * @return $this */ public function setDuration($duration) { if (!is_null($duration) && ($duration < 0)) { throw new \InvalidArgumentException('invalid value for $duration when calling Body., must be bigger than or equal to 0.'); } $this->container['duration'] = $duration; return $this; } /** * Gets taskTypeId * * @return string */ public function getTaskTypeId() { return $this->container['taskTypeId']; } /** * Sets taskTypeId * * @param string $taskTypeId Id for type of task e.g Call / Email / Meeting etc. * * @return $this */ public function setTaskTypeId($taskTypeId) { $this->container['taskTypeId'] = $taskTypeId; return $this; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Task due date and time * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets notes * * @return string */ public function getNotes() { return $this->container['notes']; } /** * Sets notes * * @param string $notes Notes added to a task * * @return $this */ public function setNotes($notes) { $this->container['notes'] = $notes; return $this; } /** * Gets done * * @return bool */ public function getDone() { return $this->container['done']; } /** * Sets done * * @param bool $done Task marked as done * * @return $this */ public function setDone($done) { $this->container['done'] = $done; return $this; } /** * Gets assignToId * * @return string */ public function getAssignToId() { return $this->container['assignToId']; } /** * Sets assignToId * * @param string $assignToId User id to whom task is assigned * * @return $this */ public function setAssignToId($assignToId) { $this->container['assignToId'] = $assignToId; return $this; } /** * Gets contactsIds * * @return int[] */ public function getContactsIds() { return $this->container['contactsIds']; } /** * Sets contactsIds * * @param int[] $contactsIds Contact ids for contacts linked to this task * * @return $this */ public function setContactsIds($contactsIds) { $this->container['contactsIds'] = $contactsIds; return $this; } /** * Gets dealsIds * * @return string[] */ public function getDealsIds() { return $this->container['dealsIds']; } /** * Sets dealsIds * * @param string[] $dealsIds Deal ids for deals a task is linked to * * @return $this */ public function setDealsIds($dealsIds) { $this->container['dealsIds'] = $dealsIds; return $this; } /** * Gets companiesIds * * @return string[] */ public function getCompaniesIds() { return $this->container['companiesIds']; } /** * Sets companiesIds * * @param string[] $companiesIds Companies ids for companies a task is linked to * * @return $this */ public function setCompaniesIds($companiesIds) { $this->container['companiesIds'] = $companiesIds; return $this; } /** * Gets reminder * * @return \Brevo\Client\Model\TaskReminder */ public function getReminder() { return $this->container['reminder']; } /** * Sets reminder * * @param \Brevo\Client\Model\TaskReminder $reminder reminder * * @return $this */ public function setReminder($reminder) { $this->container['reminder'] = $reminder; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendReportEmail.php 0000644 00000017501 15021222673 0014026 0 ustar 00 <?php /** * SendReportEmail * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendReportEmail Class Doc Comment * * @category Class * @description Custom attributes for the report email. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendReportEmail implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendReport_email'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'to' => 'string[]', 'body' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'to' => 'email', 'body' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'to' => 'to', 'body' => 'body' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'to' => 'setTo', 'body' => 'setBody' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'to' => 'getTo', 'body' => 'getBody' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['to'] = isset($data['to']) ? $data['to'] : null; $this->container['body'] = isset($data['body']) ? $data['body'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['to'] === null) { $invalidProperties[] = "'to' can't be null"; } if ($this->container['body'] === null) { $invalidProperties[] = "'body' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets to * * @return string[] */ public function getTo() { return $this->container['to']; } /** * Sets to * * @param string[] $to Email addresses of the recipients * * @return $this */ public function setTo($to) { $this->container['to'] = $to; return $this; } /** * Gets body * * @return string */ public function getBody() { return $this->container['body']; } /** * Sets body * * @param string $body Custom text message to be presented in the report email. * * @return $this */ public function setBody($body) { $this->container['body'] = $body; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetEmailCampaigns.php 0000644 00000017222 15021222673 0014303 0 ustar 00 <?php /** * GetEmailCampaigns * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetEmailCampaigns Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailCampaigns implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getEmailCampaigns'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaigns' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaigns' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaigns' => 'campaigns', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaigns' => 'setCampaigns', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaigns' => 'getCampaigns', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaigns'] = isset($data['campaigns']) ? $data['campaigns'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaigns * * @return object[] */ public function getCampaigns() { return $this->container['campaigns']; } /** * Sets campaigns * * @param object[] $campaigns campaigns * * @return $this */ public function setCampaigns($campaigns) { $this->container['campaigns'] = $campaigns; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of Email campaigns retrieved * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateDomainModelDnsRecordsDkimRecord.php 0000644 00000021526 15021222673 0020242 0 ustar 00 <?php /** * CreateDomainModelDnsRecordsDkimRecord * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateDomainModelDnsRecordsDkimRecord Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModelDnsRecordsDkimRecord implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createDomainModel_dns_records_dkim_record'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'type' => 'string', 'value' => 'string', 'hostName' => 'string', 'status' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'type' => null, 'value' => null, 'hostName' => null, 'status' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'type' => 'type', 'value' => 'value', 'hostName' => 'host_name', 'status' => 'status' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'type' => 'setType', 'value' => 'setValue', 'hostName' => 'setHostName', 'status' => 'setStatus' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'type' => 'getType', 'value' => 'getValue', 'hostName' => 'getHostName', 'status' => 'getStatus' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['value'] = isset($data['value']) ? $data['value'] : null; $this->container['hostName'] = isset($data['hostName']) ? $data['hostName'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type type * * @return $this */ public function setType($type) { $this->container['type'] = $type; return $this; } /** * Gets value * * @return string */ public function getValue() { return $this->container['value']; } /** * Sets value * * @param string $value value * * @return $this */ public function setValue($value) { $this->container['value'] = $value; return $this; } /** * Gets hostName * * @return string */ public function getHostName() { return $this->container['hostName']; } /** * Sets hostName * * @param string $hostName hostName * * @return $this */ public function setHostName($hostName) { $this->container['hostName'] = $hostName; return $this; } /** * Gets status * * @return bool */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param bool $status status * * @return $this */ public function setStatus($status) { $this->container['status'] = $status; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CompaniesList.php 0000644 00000016056 15021222673 0013547 0 ustar 00 <?php /** * CompaniesList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CompaniesList Class Doc Comment * * @category Class * @description List of companies * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompaniesList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'CompaniesList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'items' => '\Brevo\Client\Model\Company[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'items' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'items' => 'items' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'items' => 'setItems' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'items' => 'getItems' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['items'] = isset($data['items']) ? $data['items'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets items * * @return \Brevo\Client\Model\Company[] */ public function getItems() { return $this->container['items']; } /** * Sets items * * @param \Brevo\Client\Model\Company[] $items List of compaies * * @return $this */ public function setItems($items) { $this->container['items'] = $items; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse2014.php 0000644 00000016040 15021222673 0014232 0 ustar 00 <?php /** * InlineResponse2014 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse2014 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2014 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_201_4'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'uuidv4' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id ID of the object created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCategories.php 0000644 00000017602 15021222673 0013520 0 ustar 00 <?php /** * GetCategories * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCategories Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCategories implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCategories'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'categories' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'categories' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'categories' => 'categories', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'categories' => 'setCategories', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'categories' => 'getCategories', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['categories'] = isset($data['categories']) ? $data['categories'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['categories'] === null) { $invalidProperties[] = "'categories' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets categories * * @return object[] */ public function getCategories() { return $this->container['categories']; } /** * Sets categories * * @param object[] $categories categories * * @return $this */ public function setCategories($categories) { $this->container['categories'] = $categories; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of categories * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInboundEmailEventsByUuidLogs.php 0000644 00000021446 15021222673 0017136 0 ustar 00 <?php /** * GetInboundEmailEventsByUuidLogs * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInboundEmailEventsByUuidLogs Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuidLogs implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInboundEmailEventsByUuid_logs'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'date' => '\DateTime', 'type' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'date' => 'date-time', 'type' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'date' => 'date', 'type' => 'type' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'date' => 'setDate', 'type' => 'setType' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'date' => 'getDate', 'type' => 'getType' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_RECEIVED = 'received'; const TYPE_PROCESSED = 'processed'; const TYPE_WEBHOOK_FAILED = 'webhookFailed'; const TYPE_WEBHOOK_DELIVERED = 'webhookDelivered'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_RECEIVED, self::TYPE_PROCESSED, self::TYPE_WEBHOOK_FAILED, self::TYPE_WEBHOOK_DELIVERED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Date of the event * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of the event * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInboundEmailEvents.php 0000644 00000016162 15021222673 0015166 0 ustar 00 <?php /** * GetInboundEmailEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInboundEmailEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInboundEmailEvents'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'events' => '\Brevo\Client\Model\GetInboundEmailEventsEvents[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'events' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'events' => 'events' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'events' => 'setEvents' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'events' => 'getEvents' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['events'] = isset($data['events']) ? $data['events'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets events * * @return \Brevo\Client\Model\GetInboundEmailEventsEvents[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param \Brevo\Client\Model\GetInboundEmailEventsEvents[] $events events * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateModel.php 0000644 00000015767 15021222673 0013171 0 ustar 00 <?php /** * CreateModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the object created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetSegmentsSegments.php 0000644 00000022120 15021222673 0014715 0 ustar 00 <?php /** * GetSegmentsSegments * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetSegmentsSegments Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSegmentsSegments implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getSegments_segments'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'segmentName' => 'string', 'categoryName' => 'string', 'updatedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'segmentName' => null, 'categoryName' => 'string', 'updatedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'segmentName' => 'segmentName', 'categoryName' => 'categoryName', 'updatedAt' => 'updatedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'segmentName' => 'setSegmentName', 'categoryName' => 'setCategoryName', 'updatedAt' => 'setUpdatedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'segmentName' => 'getSegmentName', 'categoryName' => 'getCategoryName', 'updatedAt' => 'getUpdatedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['segmentName'] = isset($data['segmentName']) ? $data['segmentName'] : null; $this->container['categoryName'] = isset($data['categoryName']) ? $data['categoryName'] : null; $this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the list * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets segmentName * * @return string */ public function getSegmentName() { return $this->container['segmentName']; } /** * Sets segmentName * * @param string $segmentName Name of the Segment * * @return $this */ public function setSegmentName($segmentName) { $this->container['segmentName'] = $segmentName; return $this; } /** * Gets categoryName * * @return string */ public function getCategoryName() { return $this->container['categoryName']; } /** * Sets categoryName * * @param string $categoryName Name of the Segment Category * * @return $this */ public function setCategoryName($categoryName) { $this->container['categoryName'] = $categoryName; return $this; } /** * Gets updatedAt * * @return string */ public function getUpdatedAt() { return $this->container['updatedAt']; } /** * Sets updatedAt * * @param string $updatedAt Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setUpdatedAt($updatedAt) { $this->container['updatedAt'] = $updatedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetContactCampaignStatsOpened.php 0000644 00000022723 15021222673 0016640 0 ustar 00 <?php /** * GetContactCampaignStatsOpened * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetContactCampaignStatsOpened Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsOpened implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getContactCampaignStats_opened'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'count' => 'int', 'eventTime' => 'string', 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'count' => 'int64', 'eventTime' => null, 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'count' => 'count', 'eventTime' => 'eventTime', 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'count' => 'setCount', 'eventTime' => 'setEventTime', 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'count' => 'getCount', 'eventTime' => 'getEventTime', 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } if ($this->container['ip'] === null) { $invalidProperties[] = "'ip' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of openings of the campaign * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has opened the campaign * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedCampaignOverview.php 0000644 00000076203 15021222673 0016364 0 ustar 00 <?php /** * GetExtendedCampaignOverview * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedCampaignOverview Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignOverview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedCampaignOverview'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'subject' => 'string', 'type' => 'string', 'status' => 'string', 'scheduledAt' => 'string', 'abTesting' => 'bool', 'subjectA' => 'string', 'subjectB' => 'string', 'splitRule' => 'int', 'winnerCriteria' => 'string', 'winnerDelay' => 'int', 'sendAtBestTime' => 'bool', 'testSent' => 'bool', 'header' => 'string', 'footer' => 'string', 'sender' => '\Brevo\Client\Model\GetExtendedCampaignOverviewSender', 'replyTo' => 'string', 'toField' => 'string', 'htmlContent' => 'string', 'shareLink' => 'string', 'tag' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'inlineImageActivation' => 'bool', 'mirrorActive' => 'bool', 'recurring' => 'bool', 'sentDate' => 'string', 'returnBounce' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'subject' => null, 'type' => null, 'status' => null, 'scheduledAt' => null, 'abTesting' => null, 'subjectA' => null, 'subjectB' => null, 'splitRule' => null, 'winnerCriteria' => null, 'winnerDelay' => null, 'sendAtBestTime' => null, 'testSent' => null, 'header' => null, 'footer' => null, 'sender' => null, 'replyTo' => 'email', 'toField' => null, 'htmlContent' => null, 'shareLink' => 'url', 'tag' => null, 'createdAt' => null, 'modifiedAt' => null, 'inlineImageActivation' => null, 'mirrorActive' => null, 'recurring' => null, 'sentDate' => null, 'returnBounce' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'subject' => 'subject', 'type' => 'type', 'status' => 'status', 'scheduledAt' => 'scheduledAt', 'abTesting' => 'abTesting', 'subjectA' => 'subjectA', 'subjectB' => 'subjectB', 'splitRule' => 'splitRule', 'winnerCriteria' => 'winnerCriteria', 'winnerDelay' => 'winnerDelay', 'sendAtBestTime' => 'sendAtBestTime', 'testSent' => 'testSent', 'header' => 'header', 'footer' => 'footer', 'sender' => 'sender', 'replyTo' => 'replyTo', 'toField' => 'toField', 'htmlContent' => 'htmlContent', 'shareLink' => 'shareLink', 'tag' => 'tag', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'inlineImageActivation' => 'inlineImageActivation', 'mirrorActive' => 'mirrorActive', 'recurring' => 'recurring', 'sentDate' => 'sentDate', 'returnBounce' => 'returnBounce' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'subject' => 'setSubject', 'type' => 'setType', 'status' => 'setStatus', 'scheduledAt' => 'setScheduledAt', 'abTesting' => 'setAbTesting', 'subjectA' => 'setSubjectA', 'subjectB' => 'setSubjectB', 'splitRule' => 'setSplitRule', 'winnerCriteria' => 'setWinnerCriteria', 'winnerDelay' => 'setWinnerDelay', 'sendAtBestTime' => 'setSendAtBestTime', 'testSent' => 'setTestSent', 'header' => 'setHeader', 'footer' => 'setFooter', 'sender' => 'setSender', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'htmlContent' => 'setHtmlContent', 'shareLink' => 'setShareLink', 'tag' => 'setTag', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'inlineImageActivation' => 'setInlineImageActivation', 'mirrorActive' => 'setMirrorActive', 'recurring' => 'setRecurring', 'sentDate' => 'setSentDate', 'returnBounce' => 'setReturnBounce' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'subject' => 'getSubject', 'type' => 'getType', 'status' => 'getStatus', 'scheduledAt' => 'getScheduledAt', 'abTesting' => 'getAbTesting', 'subjectA' => 'getSubjectA', 'subjectB' => 'getSubjectB', 'splitRule' => 'getSplitRule', 'winnerCriteria' => 'getWinnerCriteria', 'winnerDelay' => 'getWinnerDelay', 'sendAtBestTime' => 'getSendAtBestTime', 'testSent' => 'getTestSent', 'header' => 'getHeader', 'footer' => 'getFooter', 'sender' => 'getSender', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'htmlContent' => 'getHtmlContent', 'shareLink' => 'getShareLink', 'tag' => 'getTag', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'inlineImageActivation' => 'getInlineImageActivation', 'mirrorActive' => 'getMirrorActive', 'recurring' => 'getRecurring', 'sentDate' => 'getSentDate', 'returnBounce' => 'getReturnBounce' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_CLASSIC = 'classic'; const TYPE_TRIGGER = 'trigger'; const STATUS_DRAFT = 'draft'; const STATUS_SENT = 'sent'; const STATUS_ARCHIVE = 'archive'; const STATUS_QUEUED = 'queued'; const STATUS_SUSPENDED = 'suspended'; const STATUS_IN_PROCESS = 'in_process'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_CLASSIC, self::TYPE_TRIGGER, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_DRAFT, self::STATUS_SENT, self::STATUS_ARCHIVE, self::STATUS_QUEUED, self::STATUS_SUSPENDED, self::STATUS_IN_PROCESS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['abTesting'] = isset($data['abTesting']) ? $data['abTesting'] : null; $this->container['subjectA'] = isset($data['subjectA']) ? $data['subjectA'] : null; $this->container['subjectB'] = isset($data['subjectB']) ? $data['subjectB'] : null; $this->container['splitRule'] = isset($data['splitRule']) ? $data['splitRule'] : null; $this->container['winnerCriteria'] = isset($data['winnerCriteria']) ? $data['winnerCriteria'] : null; $this->container['winnerDelay'] = isset($data['winnerDelay']) ? $data['winnerDelay'] : null; $this->container['sendAtBestTime'] = isset($data['sendAtBestTime']) ? $data['sendAtBestTime'] : null; $this->container['testSent'] = isset($data['testSent']) ? $data['testSent'] : null; $this->container['header'] = isset($data['header']) ? $data['header'] : null; $this->container['footer'] = isset($data['footer']) ? $data['footer'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['shareLink'] = isset($data['shareLink']) ? $data['shareLink'] : null; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['inlineImageActivation'] = isset($data['inlineImageActivation']) ? $data['inlineImageActivation'] : null; $this->container['mirrorActive'] = isset($data['mirrorActive']) ? $data['mirrorActive'] : null; $this->container['recurring'] = isset($data['recurring']) ? $data['recurring'] : null; $this->container['sentDate'] = isset($data['sentDate']) ? $data['sentDate'] : null; $this->container['returnBounce'] = isset($data['returnBounce']) ? $data['returnBounce'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['testSent'] === null) { $invalidProperties[] = "'testSent' can't be null"; } if ($this->container['header'] === null) { $invalidProperties[] = "'header' can't be null"; } if ($this->container['footer'] === null) { $invalidProperties[] = "'footer' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['replyTo'] === null) { $invalidProperties[] = "'replyTo' can't be null"; } if ($this->container['htmlContent'] === null) { $invalidProperties[] = "'htmlContent' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of campaign * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the campaign * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets abTesting * * @return bool */ public function getAbTesting() { return $this->container['abTesting']; } /** * Sets abTesting * * @param bool $abTesting Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. * * @return $this */ public function setAbTesting($abTesting) { $this->container['abTesting'] = $abTesting; return $this; } /** * Gets subjectA * * @return string */ public function getSubjectA() { return $this->container['subjectA']; } /** * Sets subjectA * * @param string $subjectA Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectA($subjectA) { $this->container['subjectA'] = $subjectA; return $this; } /** * Gets subjectB * * @return string */ public function getSubjectB() { return $this->container['subjectB']; } /** * Sets subjectB * * @param string $subjectB Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectB($subjectB) { $this->container['subjectB'] = $subjectB; return $this; } /** * Gets splitRule * * @return int */ public function getSplitRule() { return $this->container['splitRule']; } /** * Sets splitRule * * @param int $splitRule The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSplitRule($splitRule) { $this->container['splitRule'] = $splitRule; return $this; } /** * Gets winnerCriteria * * @return string */ public function getWinnerCriteria() { return $this->container['winnerCriteria']; } /** * Sets winnerCriteria * * @param string $winnerCriteria Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerCriteria($winnerCriteria) { $this->container['winnerCriteria'] = $winnerCriteria; return $this; } /** * Gets winnerDelay * * @return int */ public function getWinnerDelay() { return $this->container['winnerDelay']; } /** * Sets winnerDelay * * @param int $winnerDelay The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerDelay($winnerDelay) { $this->container['winnerDelay'] = $winnerDelay; return $this; } /** * Gets sendAtBestTime * * @return bool */ public function getSendAtBestTime() { return $this->container['sendAtBestTime']; } /** * Sets sendAtBestTime * * @param bool $sendAtBestTime It is true if you have chosen to send your campaign at best time, otherwise it is false * * @return $this */ public function setSendAtBestTime($sendAtBestTime) { $this->container['sendAtBestTime'] = $sendAtBestTime; return $this; } /** * Gets testSent * * @return bool */ public function getTestSent() { return $this->container['testSent']; } /** * Sets testSent * * @param bool $testSent Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) * * @return $this */ public function setTestSent($testSent) { $this->container['testSent'] = $testSent; return $this; } /** * Gets header * * @return string */ public function getHeader() { return $this->container['header']; } /** * Sets header * * @param string $header Header of the campaign * * @return $this */ public function setHeader($header) { $this->container['header'] = $header; return $this; } /** * Gets footer * * @return string */ public function getFooter() { return $this->container['footer']; } /** * Sets footer * * @param string $footer Footer of the campaign * * @return $this */ public function setFooter($footer) { $this->container['footer'] = $footer; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\GetExtendedCampaignOverviewSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\GetExtendedCampaignOverviewSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email defined as the \"Reply to\" of the campaign * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField Customisation of the \"to\" field of the campaign * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent HTML content of the campaign * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets shareLink * * @return string */ public function getShareLink() { return $this->container['shareLink']; } /** * Sets shareLink * * @param string $shareLink Link to share the campaign on social medias * * @return $this */ public function setShareLink($shareLink) { $this->container['shareLink'] = $shareLink; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the campaign * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets inlineImageActivation * * @return bool */ public function getInlineImageActivation() { return $this->container['inlineImageActivation']; } /** * Sets inlineImageActivation * * @param bool $inlineImageActivation Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. * * @return $this */ public function setInlineImageActivation($inlineImageActivation) { $this->container['inlineImageActivation'] = $inlineImageActivation; return $this; } /** * Gets mirrorActive * * @return bool */ public function getMirrorActive() { return $this->container['mirrorActive']; } /** * Sets mirrorActive * * @param bool $mirrorActive Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign * * @return $this */ public function setMirrorActive($mirrorActive) { $this->container['mirrorActive'] = $mirrorActive; return $this; } /** * Gets recurring * * @return bool */ public function getRecurring() { return $this->container['recurring']; } /** * Sets recurring * * @param bool $recurring FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times * * @return $this */ public function setRecurring($recurring) { $this->container['recurring'] = $recurring; return $this; } /** * Gets sentDate * * @return string */ public function getSentDate() { return $this->container['sentDate']; } /** * Sets sentDate * * @param string $sentDate Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' * * @return $this */ public function setSentDate($sentDate) { $this->container['sentDate'] = $sentDate; return $this; } /** * Gets returnBounce * * @return int */ public function getReturnBounce() { return $this->container['returnBounce']; } /** * Sets returnBounce * * @param int $returnBounce Total number of non-delivered campaigns for a particular campaign id. * * @return $this */ public function setReturnBounce($returnBounce) { $this->container['returnBounce'] = $returnBounce; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateBatchProductsModel.php 0000644 00000017637 15021222673 0017020 0 ustar 00 <?php /** * CreateUpdateBatchProductsModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateBatchProductsModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchProductsModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateBatchProductsModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'createdCount' => 'int', 'updatedCount' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'createdCount' => 'int64', 'updatedCount' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'createdCount' => 'createdCount', 'updatedCount' => 'updatedCount' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'createdCount' => 'setCreatedCount', 'updatedCount' => 'setUpdatedCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'createdCount' => 'getCreatedCount', 'updatedCount' => 'getUpdatedCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['createdCount'] = isset($data['createdCount']) ? $data['createdCount'] : null; $this->container['updatedCount'] = isset($data['updatedCount']) ? $data['updatedCount'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets createdCount * * @return int */ public function getCreatedCount() { return $this->container['createdCount']; } /** * Sets createdCount * * @param int $createdCount Number of the new created products * * @return $this */ public function setCreatedCount($createdCount) { $this->container['createdCount'] = $createdCount; return $this; } /** * Gets updatedCount * * @return int */ public function getUpdatedCount() { return $this->container['updatedCount']; } /** * Sets updatedCount * * @param int $updatedCount Number of the existing products updated * * @return $this */ public function setUpdatedCount($updatedCount) { $this->container['updatedCount'] = $updatedCount; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWebhook.php 0000644 00000031262 15021222673 0013027 0 ustar 00 <?php /** * GetWebhook * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWebhook Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWebhook implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWebhook'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string', 'id' => 'int', 'description' => 'string', 'events' => 'string[]', 'type' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => 'url', 'id' => 'int64', 'description' => null, 'events' => null, 'type' => null, 'createdAt' => null, 'modifiedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url', 'id' => 'id', 'description' => 'description', 'events' => 'events', 'type' => 'type', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl', 'id' => 'setId', 'description' => 'setDescription', 'events' => 'setEvents', 'type' => 'setType', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl', 'id' => 'getId', 'description' => 'getDescription', 'events' => 'getEvents', 'type' => 'getType', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_MARKETING = 'marketing'; const TYPE_TRANSACTIONAL = 'transactional'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_MARKETING, self::TYPE_TRANSACTIONAL, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['description'] = isset($data['description']) ? $data['description'] : null; $this->container['events'] = isset($data['events']) ? $data['events'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['description'] === null) { $invalidProperties[] = "'description' can't be null"; } if ($this->container['events'] === null) { $invalidProperties[] = "'events' can't be null"; } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the webhook * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the webhook * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets description * * @return string */ public function getDescription() { return $this->container['description']; } /** * Sets description * * @param string $description Description of the webhook * * @return $this */ public function setDescription($description) { $this->container['description'] = $description; return $this; } /** * Gets events * * @return string[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param string[] $events events * * @return $this */ public function setEvents($events) { $this->container['events'] = $events; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of webhook (marketing or transactional) * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/OrderProducts.php 0000644 00000022673 15021222673 0013576 0 ustar 00 <?php /** * OrderProducts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * OrderProducts Class Doc Comment * * @category Class * @description Details for the Products in an order. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderProducts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'order_products'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'productId' => 'string', 'quantity' => 'float', 'variantId' => 'string', 'price' => 'float' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'productId' => null, 'quantity' => null, 'variantId' => null, 'price' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'productId' => 'productId', 'quantity' => 'quantity', 'variantId' => 'variantId', 'price' => 'price' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'productId' => 'setProductId', 'quantity' => 'setQuantity', 'variantId' => 'setVariantId', 'price' => 'setPrice' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'productId' => 'getProductId', 'quantity' => 'getQuantity', 'variantId' => 'getVariantId', 'price' => 'getPrice' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['productId'] = isset($data['productId']) ? $data['productId'] : null; $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['variantId'] = isset($data['variantId']) ? $data['variantId'] : null; $this->container['price'] = isset($data['price']) ? $data['price'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['productId'] === null) { $invalidProperties[] = "'productId' can't be null"; } if ($this->container['quantity'] === null) { $invalidProperties[] = "'quantity' can't be null"; } if ($this->container['price'] === null) { $invalidProperties[] = "'price' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets productId * * @return string */ public function getProductId() { return $this->container['productId']; } /** * Sets productId * * @param string $productId ID of the product. * * @return $this */ public function setProductId($productId) { $this->container['productId'] = $productId; return $this; } /** * Gets quantity * * @return float */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param float $quantity How many pieces of the product the visitor has added to the cart. * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets variantId * * @return string */ public function getVariantId() { return $this->container['variantId']; } /** * Sets variantId * * @param string $variantId Product ID of the red color shirts. * * @return $this */ public function setVariantId($variantId) { $this->container['variantId'] = $variantId; return $this; } /** * Gets price * * @return float */ public function getPrice() { return $this->container['price']; } /** * Sets price * * @param float $price The price of a unit of product * * @return $this */ public function setPrice($price) { $this->container['price'] = $price; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponsePlanInfo.php 0000644 00000027500 15021222673 0016700 0 ustar 00 <?php /** * MasterDetailsResponsePlanInfo * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponsePlanInfo Class Doc Comment * * @category Class * @description Plan details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponsePlanInfo implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse_planInfo'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'currencyCode' => 'string', 'nextBillingAt' => 'int', 'price' => 'float', 'planPeriod' => 'string', 'subAccounts' => 'int', 'features' => '\Brevo\Client\Model\MasterDetailsResponsePlanInfoFeatures[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'currencyCode' => null, 'nextBillingAt' => 'int64', 'price' => null, 'planPeriod' => null, 'subAccounts' => null, 'features' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'currencyCode' => 'currencyCode', 'nextBillingAt' => 'nextBillingAt', 'price' => 'price', 'planPeriod' => 'planPeriod', 'subAccounts' => 'subAccounts', 'features' => 'features' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'currencyCode' => 'setCurrencyCode', 'nextBillingAt' => 'setNextBillingAt', 'price' => 'setPrice', 'planPeriod' => 'setPlanPeriod', 'subAccounts' => 'setSubAccounts', 'features' => 'setFeatures' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'currencyCode' => 'getCurrencyCode', 'nextBillingAt' => 'getNextBillingAt', 'price' => 'getPrice', 'planPeriod' => 'getPlanPeriod', 'subAccounts' => 'getSubAccounts', 'features' => 'getFeatures' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const PLAN_PERIOD_MONTH = 'month'; const PLAN_PERIOD_YEAR = 'year'; /** * Gets allowable values of the enum * * @return string[] */ public function getPlanPeriodAllowableValues() { return [ self::PLAN_PERIOD_MONTH, self::PLAN_PERIOD_YEAR, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['currencyCode'] = isset($data['currencyCode']) ? $data['currencyCode'] : null; $this->container['nextBillingAt'] = isset($data['nextBillingAt']) ? $data['nextBillingAt'] : null; $this->container['price'] = isset($data['price']) ? $data['price'] : null; $this->container['planPeriod'] = isset($data['planPeriod']) ? $data['planPeriod'] : null; $this->container['subAccounts'] = isset($data['subAccounts']) ? $data['subAccounts'] : null; $this->container['features'] = isset($data['features']) ? $data['features'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getPlanPeriodAllowableValues(); if (!is_null($this->container['planPeriod']) && !in_array($this->container['planPeriod'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'planPeriod', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets currencyCode * * @return string */ public function getCurrencyCode() { return $this->container['currencyCode']; } /** * Sets currencyCode * * @param string $currencyCode Plan currency * * @return $this */ public function setCurrencyCode($currencyCode) { $this->container['currencyCode'] = $currencyCode; return $this; } /** * Gets nextBillingAt * * @return int */ public function getNextBillingAt() { return $this->container['nextBillingAt']; } /** * Sets nextBillingAt * * @param int $nextBillingAt Timestamp of next billing date * * @return $this */ public function setNextBillingAt($nextBillingAt) { $this->container['nextBillingAt'] = $nextBillingAt; return $this; } /** * Gets price * * @return float */ public function getPrice() { return $this->container['price']; } /** * Sets price * * @param float $price Plan amount * * @return $this */ public function setPrice($price) { $this->container['price'] = $price; return $this; } /** * Gets planPeriod * * @return string */ public function getPlanPeriod() { return $this->container['planPeriod']; } /** * Sets planPeriod * * @param string $planPeriod Plan period type * * @return $this */ public function setPlanPeriod($planPeriod) { $allowedValues = $this->getPlanPeriodAllowableValues(); if (!is_null($planPeriod) && !in_array($planPeriod, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'planPeriod', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['planPeriod'] = $planPeriod; return $this; } /** * Gets subAccounts * * @return int */ public function getSubAccounts() { return $this->container['subAccounts']; } /** * Sets subAccounts * * @param int $subAccounts Number of sub-accounts * * @return $this */ public function setSubAccounts($subAccounts) { $this->container['subAccounts'] = $subAccounts; return $this; } /** * Gets features * * @return \Brevo\Client\Model\MasterDetailsResponsePlanInfoFeatures[] */ public function getFeatures() { return $this->container['features']; } /** * Sets features * * @param \Brevo\Client\Model\MasterDetailsResponsePlanInfoFeatures[] $features List of provided features in the plan * * @return $this */ public function setFeatures($features) { $this->container['features'] = $features; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/DealAttributes.php 0000644 00000014733 15021222673 0013711 0 ustar 00 <?php /** * DealAttributes * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * DealAttributes Class Doc Comment * * @category Class * @description List of deal attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealAttributes implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'DealAttributes'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetDomainConfigurationModel.php 0000644 00000023500 15021222673 0016345 0 ustar 00 <?php /** * GetDomainConfigurationModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetDomainConfigurationModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainConfigurationModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getDomainConfigurationModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domain' => 'string', 'verified' => 'bool', 'authenticated' => 'bool', 'dnsRecords' => '\Brevo\Client\Model\CreateDomainModelDnsRecords' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domain' => null, 'verified' => null, 'authenticated' => null, 'dnsRecords' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domain' => 'domain', 'verified' => 'verified', 'authenticated' => 'authenticated', 'dnsRecords' => 'dns_records' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domain' => 'setDomain', 'verified' => 'setVerified', 'authenticated' => 'setAuthenticated', 'dnsRecords' => 'setDnsRecords' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domain' => 'getDomain', 'verified' => 'getVerified', 'authenticated' => 'getAuthenticated', 'dnsRecords' => 'getDnsRecords' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; $this->container['verified'] = isset($data['verified']) ? $data['verified'] : null; $this->container['authenticated'] = isset($data['authenticated']) ? $data['authenticated'] : null; $this->container['dnsRecords'] = isset($data['dnsRecords']) ? $data['dnsRecords'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } if ($this->container['verified'] === null) { $invalidProperties[] = "'verified' can't be null"; } if ($this->container['authenticated'] === null) { $invalidProperties[] = "'authenticated' can't be null"; } if ($this->container['dnsRecords'] === null) { $invalidProperties[] = "'dnsRecords' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Domain * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Gets verified * * @return bool */ public function getVerified() { return $this->container['verified']; } /** * Sets verified * * @param bool $verified Status of domain verification (true=verified, false=non verified) * * @return $this */ public function setVerified($verified) { $this->container['verified'] = $verified; return $this; } /** * Gets authenticated * * @return bool */ public function getAuthenticated() { return $this->container['authenticated']; } /** * Sets authenticated * * @param bool $authenticated Status of domain authentication (true=authenticated, false=non authenticated) * * @return $this */ public function setAuthenticated($authenticated) { $this->container['authenticated'] = $authenticated; return $this; } /** * Gets dnsRecords * * @return \Brevo\Client\Model\CreateDomainModelDnsRecords */ public function getDnsRecords() { return $this->container['dnsRecords']; } /** * Sets dnsRecords * * @param \Brevo\Client\Model\CreateDomainModelDnsRecords $dnsRecords dnsRecords * * @return $this */ public function setDnsRecords($dnsRecords) { $this->container['dnsRecords'] = $dnsRecords; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UploadImageModel.php 0000644 00000016054 15021222673 0014143 0 ustar 00 <?php /** * UploadImageModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UploadImageModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UploadImageModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'uploadImageModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => 'string' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the image uploaded * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestVersionClicksInner.php 0000644 00000021423 15021222673 0015644 0 ustar 00 <?php /** * AbTestVersionClicksInner * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestVersionClicksInner Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionClicksInner implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestVersionClicks_inner'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'link' => 'string', 'clicksCount' => 'int', 'clickRate' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'link' => null, 'clicksCount' => 'int64', 'clickRate' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'link' => 'link', 'clicksCount' => 'clicksCount', 'clickRate' => 'clickRate' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'link' => 'setLink', 'clicksCount' => 'setClicksCount', 'clickRate' => 'setClickRate' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'link' => 'getLink', 'clicksCount' => 'getClicksCount', 'clickRate' => 'getClickRate' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['link'] = isset($data['link']) ? $data['link'] : null; $this->container['clicksCount'] = isset($data['clicksCount']) ? $data['clicksCount'] : null; $this->container['clickRate'] = isset($data['clickRate']) ? $data['clickRate'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['link'] === null) { $invalidProperties[] = "'link' can't be null"; } if ($this->container['clicksCount'] === null) { $invalidProperties[] = "'clicksCount' can't be null"; } if ($this->container['clickRate'] === null) { $invalidProperties[] = "'clickRate' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets link * * @return string */ public function getLink() { return $this->container['link']; } /** * Sets link * * @param string $link URL of the link * * @return $this */ public function setLink($link) { $this->container['link'] = $link; return $this; } /** * Gets clicksCount * * @return int */ public function getClicksCount() { return $this->container['clicksCount']; } /** * Sets clicksCount * * @param int $clicksCount Number of times a link is clicked * * @return $this */ public function setClicksCount($clicksCount) { $this->container['clicksCount'] = $clicksCount; return $this; } /** * Gets clickRate * * @return string */ public function getClickRate() { return $this->container['clickRate']; } /** * Sets clickRate * * @param string $clickRate Percentage of clicks of link with respect to total clicks * * @return $this */ public function setClickRate($clickRate) { $this->container['clickRate'] = $clickRate; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateEmailCampaign.php 0000644 00000107433 15021222673 0014627 0 ustar 00 <?php /** * UpdateEmailCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateEmailCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateEmailCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'tag' => 'string', 'sender' => '\Brevo\Client\Model\UpdateEmailCampaignSender', 'name' => 'string', 'htmlContent' => 'string', 'htmlUrl' => 'string', 'scheduledAt' => 'string', 'subject' => 'string', 'previewText' => 'string', 'replyTo' => 'string', 'toField' => 'string', 'recipients' => '\Brevo\Client\Model\UpdateEmailCampaignRecipients', 'attachmentUrl' => 'string', 'inlineImageActivation' => 'bool', 'mirrorActive' => 'bool', 'recurring' => 'bool', 'footer' => 'string', 'header' => 'string', 'utmCampaign' => 'string', 'params' => 'object', 'sendAtBestTime' => 'bool', 'abTesting' => 'bool', 'subjectA' => 'string', 'subjectB' => 'string', 'splitRule' => 'int', 'winnerCriteria' => 'string', 'winnerDelay' => 'int', 'ipWarmupEnable' => 'bool', 'initialQuota' => 'int', 'increaseRate' => 'int', 'unsubscriptionPageId' => 'string', 'updateFormId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'tag' => null, 'sender' => null, 'name' => null, 'htmlContent' => null, 'htmlUrl' => 'url', 'scheduledAt' => null, 'subject' => null, 'previewText' => null, 'replyTo' => 'email', 'toField' => null, 'recipients' => null, 'attachmentUrl' => 'url', 'inlineImageActivation' => null, 'mirrorActive' => null, 'recurring' => null, 'footer' => null, 'header' => null, 'utmCampaign' => null, 'params' => null, 'sendAtBestTime' => null, 'abTesting' => null, 'subjectA' => null, 'subjectB' => null, 'splitRule' => 'int64', 'winnerCriteria' => null, 'winnerDelay' => 'int64', 'ipWarmupEnable' => null, 'initialQuota' => 'int64', 'increaseRate' => 'int64', 'unsubscriptionPageId' => null, 'updateFormId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'tag' => 'tag', 'sender' => 'sender', 'name' => 'name', 'htmlContent' => 'htmlContent', 'htmlUrl' => 'htmlUrl', 'scheduledAt' => 'scheduledAt', 'subject' => 'subject', 'previewText' => 'previewText', 'replyTo' => 'replyTo', 'toField' => 'toField', 'recipients' => 'recipients', 'attachmentUrl' => 'attachmentUrl', 'inlineImageActivation' => 'inlineImageActivation', 'mirrorActive' => 'mirrorActive', 'recurring' => 'recurring', 'footer' => 'footer', 'header' => 'header', 'utmCampaign' => 'utmCampaign', 'params' => 'params', 'sendAtBestTime' => 'sendAtBestTime', 'abTesting' => 'abTesting', 'subjectA' => 'subjectA', 'subjectB' => 'subjectB', 'splitRule' => 'splitRule', 'winnerCriteria' => 'winnerCriteria', 'winnerDelay' => 'winnerDelay', 'ipWarmupEnable' => 'ipWarmupEnable', 'initialQuota' => 'initialQuota', 'increaseRate' => 'increaseRate', 'unsubscriptionPageId' => 'unsubscriptionPageId', 'updateFormId' => 'updateFormId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'tag' => 'setTag', 'sender' => 'setSender', 'name' => 'setName', 'htmlContent' => 'setHtmlContent', 'htmlUrl' => 'setHtmlUrl', 'scheduledAt' => 'setScheduledAt', 'subject' => 'setSubject', 'previewText' => 'setPreviewText', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'recipients' => 'setRecipients', 'attachmentUrl' => 'setAttachmentUrl', 'inlineImageActivation' => 'setInlineImageActivation', 'mirrorActive' => 'setMirrorActive', 'recurring' => 'setRecurring', 'footer' => 'setFooter', 'header' => 'setHeader', 'utmCampaign' => 'setUtmCampaign', 'params' => 'setParams', 'sendAtBestTime' => 'setSendAtBestTime', 'abTesting' => 'setAbTesting', 'subjectA' => 'setSubjectA', 'subjectB' => 'setSubjectB', 'splitRule' => 'setSplitRule', 'winnerCriteria' => 'setWinnerCriteria', 'winnerDelay' => 'setWinnerDelay', 'ipWarmupEnable' => 'setIpWarmupEnable', 'initialQuota' => 'setInitialQuota', 'increaseRate' => 'setIncreaseRate', 'unsubscriptionPageId' => 'setUnsubscriptionPageId', 'updateFormId' => 'setUpdateFormId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'tag' => 'getTag', 'sender' => 'getSender', 'name' => 'getName', 'htmlContent' => 'getHtmlContent', 'htmlUrl' => 'getHtmlUrl', 'scheduledAt' => 'getScheduledAt', 'subject' => 'getSubject', 'previewText' => 'getPreviewText', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'recipients' => 'getRecipients', 'attachmentUrl' => 'getAttachmentUrl', 'inlineImageActivation' => 'getInlineImageActivation', 'mirrorActive' => 'getMirrorActive', 'recurring' => 'getRecurring', 'footer' => 'getFooter', 'header' => 'getHeader', 'utmCampaign' => 'getUtmCampaign', 'params' => 'getParams', 'sendAtBestTime' => 'getSendAtBestTime', 'abTesting' => 'getAbTesting', 'subjectA' => 'getSubjectA', 'subjectB' => 'getSubjectB', 'splitRule' => 'getSplitRule', 'winnerCriteria' => 'getWinnerCriteria', 'winnerDelay' => 'getWinnerDelay', 'ipWarmupEnable' => 'getIpWarmupEnable', 'initialQuota' => 'getInitialQuota', 'increaseRate' => 'getIncreaseRate', 'unsubscriptionPageId' => 'getUnsubscriptionPageId', 'updateFormId' => 'getUpdateFormId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const WINNER_CRITERIA_OPEN = 'open'; const WINNER_CRITERIA_CLICK = 'click'; /** * Gets allowable values of the enum * * @return string[] */ public function getWinnerCriteriaAllowableValues() { return [ self::WINNER_CRITERIA_OPEN, self::WINNER_CRITERIA_CLICK, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['htmlUrl'] = isset($data['htmlUrl']) ? $data['htmlUrl'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['previewText'] = isset($data['previewText']) ? $data['previewText'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['attachmentUrl'] = isset($data['attachmentUrl']) ? $data['attachmentUrl'] : null; $this->container['inlineImageActivation'] = isset($data['inlineImageActivation']) ? $data['inlineImageActivation'] : false; $this->container['mirrorActive'] = isset($data['mirrorActive']) ? $data['mirrorActive'] : null; $this->container['recurring'] = isset($data['recurring']) ? $data['recurring'] : false; $this->container['footer'] = isset($data['footer']) ? $data['footer'] : null; $this->container['header'] = isset($data['header']) ? $data['header'] : null; $this->container['utmCampaign'] = isset($data['utmCampaign']) ? $data['utmCampaign'] : null; $this->container['params'] = isset($data['params']) ? $data['params'] : null; $this->container['sendAtBestTime'] = isset($data['sendAtBestTime']) ? $data['sendAtBestTime'] : null; $this->container['abTesting'] = isset($data['abTesting']) ? $data['abTesting'] : false; $this->container['subjectA'] = isset($data['subjectA']) ? $data['subjectA'] : null; $this->container['subjectB'] = isset($data['subjectB']) ? $data['subjectB'] : null; $this->container['splitRule'] = isset($data['splitRule']) ? $data['splitRule'] : null; $this->container['winnerCriteria'] = isset($data['winnerCriteria']) ? $data['winnerCriteria'] : null; $this->container['winnerDelay'] = isset($data['winnerDelay']) ? $data['winnerDelay'] : null; $this->container['ipWarmupEnable'] = isset($data['ipWarmupEnable']) ? $data['ipWarmupEnable'] : false; $this->container['initialQuota'] = isset($data['initialQuota']) ? $data['initialQuota'] : null; $this->container['increaseRate'] = isset($data['increaseRate']) ? $data['increaseRate'] : null; $this->container['unsubscriptionPageId'] = isset($data['unsubscriptionPageId']) ? $data['unsubscriptionPageId'] : null; $this->container['updateFormId'] = isset($data['updateFormId']) ? $data['updateFormId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if (!is_null($this->container['splitRule']) && ($this->container['splitRule'] > 50)) { $invalidProperties[] = "invalid value for 'splitRule', must be smaller than or equal to 50."; } if (!is_null($this->container['splitRule']) && ($this->container['splitRule'] < 1)) { $invalidProperties[] = "invalid value for 'splitRule', must be bigger than or equal to 1."; } $allowedValues = $this->getWinnerCriteriaAllowableValues(); if (!is_null($this->container['winnerCriteria']) && !in_array($this->container['winnerCriteria'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'winnerCriteria', must be one of '%s'", implode("', '", $allowedValues) ); } if (!is_null($this->container['winnerDelay']) && ($this->container['winnerDelay'] > 168)) { $invalidProperties[] = "invalid value for 'winnerDelay', must be smaller than or equal to 168."; } if (!is_null($this->container['winnerDelay']) && ($this->container['winnerDelay'] < 1)) { $invalidProperties[] = "invalid value for 'winnerDelay', must be bigger than or equal to 1."; } if (!is_null($this->container['increaseRate']) && ($this->container['increaseRate'] > 100)) { $invalidProperties[] = "invalid value for 'increaseRate', must be smaller than or equal to 100."; } if (!is_null($this->container['increaseRate']) && ($this->container['increaseRate'] < 0)) { $invalidProperties[] = "invalid value for 'increaseRate', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the campaign * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\UpdateEmailCampaignSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\UpdateEmailCampaignSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets htmlUrl * * @return string */ public function getHtmlUrl() { return $this->container['htmlUrl']; } /** * Sets htmlUrl * * @param string $htmlUrl Url which contents the body of the email message. REQUIRED if htmlContent is empty * * @return $this */ public function setHtmlUrl($htmlUrl) { $this->container['htmlUrl'] = $htmlUrl; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the campaign * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets previewText * * @return string */ public function getPreviewText() { return $this->container['previewText']; } /** * Sets previewText * * @param string $previewText Preview text or preheader of the email campaign * * @return $this */ public function setPreviewText($previewText) { $this->container['previewText'] = $previewText; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email on which campaign recipients will be able to reply to * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\UpdateEmailCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\UpdateEmailCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets attachmentUrl * * @return string */ public function getAttachmentUrl() { return $this->container['attachmentUrl']; } /** * Sets attachmentUrl * * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * * @return $this */ public function setAttachmentUrl($attachmentUrl) { $this->container['attachmentUrl'] = $attachmentUrl; return $this; } /** * Gets inlineImageActivation * * @return bool */ public function getInlineImageActivation() { return $this->container['inlineImageActivation']; } /** * Sets inlineImageActivation * * @param bool $inlineImageActivation Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. * * @return $this */ public function setInlineImageActivation($inlineImageActivation) { $this->container['inlineImageActivation'] = $inlineImageActivation; return $this; } /** * Gets mirrorActive * * @return bool */ public function getMirrorActive() { return $this->container['mirrorActive']; } /** * Sets mirrorActive * * @param bool $mirrorActive Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign * * @return $this */ public function setMirrorActive($mirrorActive) { $this->container['mirrorActive'] = $mirrorActive; return $this; } /** * Gets recurring * * @return bool */ public function getRecurring() { return $this->container['recurring']; } /** * Sets recurring * * @param bool $recurring FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times * * @return $this */ public function setRecurring($recurring) { $this->container['recurring'] = $recurring; return $this; } /** * Gets footer * * @return string */ public function getFooter() { return $this->container['footer']; } /** * Sets footer * * @param string $footer Footer of the email campaign * * @return $this */ public function setFooter($footer) { $this->container['footer'] = $footer; return $this; } /** * Gets header * * @return string */ public function getHeader() { return $this->container['header']; } /** * Sets header * * @param string $header Header of the email campaign * * @return $this */ public function setHeader($header) { $this->container['header'] = $header; return $this; } /** * Gets utmCampaign * * @return string */ public function getUtmCampaign() { return $this->container['utmCampaign']; } /** * Sets utmCampaign * * @param string $utmCampaign Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed * * @return $this */ public function setUtmCampaign($utmCampaign) { $this->container['utmCampaign'] = $utmCampaign; return $this; } /** * Gets params * * @return object */ public function getParams() { return $this->container['params']; } /** * Sets params * * @param object $params Pass the set of attributes to customize the type 'classic' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' * * @return $this */ public function setParams($params) { $this->container['params'] = $params; return $this; } /** * Gets sendAtBestTime * * @return bool */ public function getSendAtBestTime() { return $this->container['sendAtBestTime']; } /** * Sets sendAtBestTime * * @param bool $sendAtBestTime Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. * * @return $this */ public function setSendAtBestTime($sendAtBestTime) { $this->container['sendAtBestTime'] = $sendAtBestTime; return $this; } /** * Gets abTesting * * @return bool */ public function getAbTesting() { return $this->container['abTesting']; } /** * Sets abTesting * * @param bool $abTesting Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B * * @return $this */ public function setAbTesting($abTesting) { $this->container['abTesting'] = $abTesting; return $this; } /** * Gets subjectA * * @return string */ public function getSubjectA() { return $this->container['subjectA']; } /** * Sets subjectA * * @param string $subjectA Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value * * @return $this */ public function setSubjectA($subjectA) { $this->container['subjectA'] = $subjectA; return $this; } /** * Gets subjectB * * @return string */ public function getSubjectB() { return $this->container['subjectB']; } /** * Sets subjectB * * @param string $subjectB Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value * * @return $this */ public function setSubjectB($subjectB) { $this->container['subjectB'] = $subjectB; return $this; } /** * Gets splitRule * * @return int */ public function getSplitRule() { return $this->container['splitRule']; } /** * Sets splitRule * * @param int $splitRule Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else * * @return $this */ public function setSplitRule($splitRule) { if (!is_null($splitRule) && ($splitRule > 50)) { throw new \InvalidArgumentException('invalid value for $splitRule when calling UpdateEmailCampaign., must be smaller than or equal to 50.'); } if (!is_null($splitRule) && ($splitRule < 1)) { throw new \InvalidArgumentException('invalid value for $splitRule when calling UpdateEmailCampaign., must be bigger than or equal to 1.'); } $this->container['splitRule'] = $splitRule; return $this; } /** * Gets winnerCriteria * * @return string */ public function getWinnerCriteria() { return $this->container['winnerCriteria']; } /** * Sets winnerCriteria * * @param string $winnerCriteria Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record * * @return $this */ public function setWinnerCriteria($winnerCriteria) { $allowedValues = $this->getWinnerCriteriaAllowableValues(); if (!is_null($winnerCriteria) && !in_array($winnerCriteria, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'winnerCriteria', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['winnerCriteria'] = $winnerCriteria; return $this; } /** * Gets winnerDelay * * @return int */ public function getWinnerDelay() { return $this->container['winnerDelay']; } /** * Sets winnerDelay * * @param int $winnerDelay Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record * * @return $this */ public function setWinnerDelay($winnerDelay) { if (!is_null($winnerDelay) && ($winnerDelay > 168)) { throw new \InvalidArgumentException('invalid value for $winnerDelay when calling UpdateEmailCampaign., must be smaller than or equal to 168.'); } if (!is_null($winnerDelay) && ($winnerDelay < 1)) { throw new \InvalidArgumentException('invalid value for $winnerDelay when calling UpdateEmailCampaign., must be bigger than or equal to 1.'); } $this->container['winnerDelay'] = $winnerDelay; return $this; } /** * Gets ipWarmupEnable * * @return bool */ public function getIpWarmupEnable() { return $this->container['ipWarmupEnable']; } /** * Sets ipWarmupEnable * * @param bool $ipWarmupEnable Available for dedicated ip clients. Set this to true if you wish to warm up your ip. * * @return $this */ public function setIpWarmupEnable($ipWarmupEnable) { $this->container['ipWarmupEnable'] = $ipWarmupEnable; return $this; } /** * Gets initialQuota * * @return int */ public function getInitialQuota() { return $this->container['initialQuota']; } /** * Sets initialQuota * * @param int $initialQuota Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. * * @return $this */ public function setInitialQuota($initialQuota) { $this->container['initialQuota'] = $initialQuota; return $this; } /** * Gets increaseRate * * @return int */ public function getIncreaseRate() { return $this->container['increaseRate']; } /** * Sets increaseRate * * @param int $increaseRate Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. * * @return $this */ public function setIncreaseRate($increaseRate) { if (!is_null($increaseRate) && ($increaseRate > 100)) { throw new \InvalidArgumentException('invalid value for $increaseRate when calling UpdateEmailCampaign., must be smaller than or equal to 100.'); } if (!is_null($increaseRate) && ($increaseRate < 0)) { throw new \InvalidArgumentException('invalid value for $increaseRate when calling UpdateEmailCampaign., must be bigger than or equal to 0.'); } $this->container['increaseRate'] = $increaseRate; return $this; } /** * Gets unsubscriptionPageId * * @return string */ public function getUnsubscriptionPageId() { return $this->container['unsubscriptionPageId']; } /** * Sets unsubscriptionPageId * * @param string $unsubscriptionPageId Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. * * @return $this */ public function setUnsubscriptionPageId($unsubscriptionPageId) { $this->container['unsubscriptionPageId'] = $unsubscriptionPageId; return $this; } /** * Gets updateFormId * * @return string */ public function getUpdateFormId() { return $this->container['updateFormId']; } /** * Sets updateFormId * * @param string $updateFormId Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. * * @return $this */ public function setUpdateFormId($updateFormId) { $this->container['updateFormId'] = $updateFormId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestContactImportJsonBody.php 0000644 00000017315 15021222673 0016603 0 ustar 00 <?php /** * RequestContactImportJsonBody * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestContactImportJsonBody Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImportJsonBody implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestContactImport_jsonBody'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'attributes' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => null, 'attributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'attributes' => 'attributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'attributes' => 'setAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'attributes' => 'getAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets attributes * * @return object */ public function getAttributes() { return $this->container['attributes']; } /** * Sets attributes * * @param object $attributes List of attributes to be imported * * @return $this */ public function setAttributes($attributes) { $this->container['attributes'] = $attributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AddChildDomain.php 0000644 00000016000 15021222673 0013546 0 ustar 00 <?php /** * AddChildDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AddChildDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddChildDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'addChildDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Sender domain to add for a specific child account * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/VariablesItems.php 0000644 00000020274 15021222673 0013704 0 ustar 00 <?php /** * VariablesItems * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * VariablesItems Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class VariablesItems implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'variablesItems'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'default' => 'string', 'datatype' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'default' => null, 'datatype' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'default' => 'default', 'datatype' => 'datatype' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'default' => 'setDefault', 'datatype' => 'setDatatype' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'default' => 'getDefault', 'datatype' => 'getDatatype' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['default'] = isset($data['default']) ? $data['default'] : null; $this->container['datatype'] = isset($data['datatype']) ? $data['datatype'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets default * * @return string */ public function getDefault() { return $this->container['default']; } /** * Sets default * * @param string $default default * * @return $this */ public function setDefault($default) { $this->container['default'] = $default; return $this; } /** * Gets datatype * * @return string */ public function getDatatype() { return $this->container['datatype']; } /** * Sets datatype * * @param string $datatype datatype * * @return $this */ public function setDatatype($datatype) { $this->container['datatype'] = $datatype; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.php 0000644 00000017567 15021222673 0022250 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesUsers * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoFeaturesUsers Class Doc Comment * * @category Class * @description Multi-account details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesUsers implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_features_users'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'quantity' => 'int', 'remaining' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'quantity' => 'int64', 'remaining' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'quantity' => 'quantity', 'remaining' => 'remaining' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'quantity' => 'setQuantity', 'remaining' => 'setRemaining' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'quantity' => 'getQuantity', 'remaining' => 'getRemaining' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets quantity * * @return int */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param int $quantity Quantity of multi-account's provided * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Available multi-accounts for use * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateList.php 0000644 00000017533 15021222673 0013035 0 ustar 00 <?php /** * CreateList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'folderId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'folderId' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'folderId' => 'folderId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'folderId' => 'setFolderId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'folderId' => 'getFolderId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['folderId'] = isset($data['folderId']) ? $data['folderId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['folderId'] === null) { $invalidProperties[] = "'folderId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the list * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets folderId * * @return int */ public function getFolderId() { return $this->container['folderId']; } /** * Sets folderId * * @param int $folderId Id of the parent folder in which this list is to be created * * @return $this */ public function setFolderId($folderId) { $this->container['folderId'] = $folderId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountPlan.php 0000644 00000032502 15021222673 0013636 0 ustar 00 <?php /** * GetAccountPlan * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountPlan Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountPlan implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccount_plan'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'type' => 'string', 'creditsType' => 'string', 'credits' => 'float', 'startDate' => '\DateTime', 'endDate' => '\DateTime', 'userLimit' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'type' => null, 'creditsType' => null, 'credits' => 'float', 'startDate' => 'date', 'endDate' => 'date', 'userLimit' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'type' => 'type', 'creditsType' => 'creditsType', 'credits' => 'credits', 'startDate' => 'startDate', 'endDate' => 'endDate', 'userLimit' => 'userLimit' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'type' => 'setType', 'creditsType' => 'setCreditsType', 'credits' => 'setCredits', 'startDate' => 'setStartDate', 'endDate' => 'setEndDate', 'userLimit' => 'setUserLimit' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'type' => 'getType', 'creditsType' => 'getCreditsType', 'credits' => 'getCredits', 'startDate' => 'getStartDate', 'endDate' => 'getEndDate', 'userLimit' => 'getUserLimit' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_PAY_AS_YOU_GO = 'payAsYouGo'; const TYPE_FREE = 'free'; const TYPE_SUBSCRIPTION = 'subscription'; const TYPE_SMS = 'sms'; const TYPE_RESELLER = 'reseller'; const CREDITS_TYPE_SEND_LIMIT = 'sendLimit'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_PAY_AS_YOU_GO, self::TYPE_FREE, self::TYPE_SUBSCRIPTION, self::TYPE_SMS, self::TYPE_RESELLER, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getCreditsTypeAllowableValues() { return [ self::CREDITS_TYPE_SEND_LIMIT, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['creditsType'] = isset($data['creditsType']) ? $data['creditsType'] : null; $this->container['credits'] = isset($data['credits']) ? $data['credits'] : null; $this->container['startDate'] = isset($data['startDate']) ? $data['startDate'] : null; $this->container['endDate'] = isset($data['endDate']) ? $data['endDate'] : null; $this->container['userLimit'] = isset($data['userLimit']) ? $data['userLimit'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['creditsType'] === null) { $invalidProperties[] = "'creditsType' can't be null"; } $allowedValues = $this->getCreditsTypeAllowableValues(); if (!is_null($this->container['creditsType']) && !in_array($this->container['creditsType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'creditsType', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['credits'] === null) { $invalidProperties[] = "'credits' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Displays the plan type of the user * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets creditsType * * @return string */ public function getCreditsType() { return $this->container['creditsType']; } /** * Sets creditsType * * @param string $creditsType This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. * * @return $this */ public function setCreditsType($creditsType) { $allowedValues = $this->getCreditsTypeAllowableValues(); if (!in_array($creditsType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'creditsType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['creditsType'] = $creditsType; return $this; } /** * Gets credits * * @return float */ public function getCredits() { return $this->container['credits']; } /** * Sets credits * * @param float $credits Remaining credits of the user * * @return $this */ public function setCredits($credits) { $this->container['credits'] = $credits; return $this; } /** * Gets startDate * * @return \DateTime */ public function getStartDate() { return $this->container['startDate']; } /** * Sets startDate * * @param \DateTime $startDate Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type) * * @return $this */ public function setStartDate($startDate) { $this->container['startDate'] = $startDate; return $this; } /** * Gets endDate * * @return \DateTime */ public function getEndDate() { return $this->container['endDate']; } /** * Sets endDate * * @param \DateTime $endDate Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type) * * @return $this */ public function setEndDate($endDate) { $this->container['endDate'] = $endDate; return $this; } /** * Gets userLimit * * @return int */ public function getUserLimit() { return $this->container['userLimit']; } /** * Sets userLimit * * @param int $userLimit Only in case of reseller account. It implies the total number of child accounts you can add to your account. * * @return $this */ public function setUserLimit($userLimit) { $this->container['userLimit'] = $userLimit; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetScheduledEmailByMessageId.php 0000644 00000024053 15021222673 0016356 0 ustar 00 <?php /** * GetScheduledEmailByMessageId * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetScheduledEmailByMessageId Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByMessageId implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getScheduledEmailByMessageId'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'scheduledAt' => '\DateTime', 'createdAt' => '\DateTime', 'status' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'scheduledAt' => 'date-time', 'createdAt' => 'date-time', 'status' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'scheduledAt' => 'scheduledAt', 'createdAt' => 'createdAt', 'status' => 'status' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'scheduledAt' => 'setScheduledAt', 'createdAt' => 'setCreatedAt', 'status' => 'setStatus' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'scheduledAt' => 'getScheduledAt', 'createdAt' => 'getCreatedAt', 'status' => 'getStatus' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_IN_PROGRESS = 'inProgress'; const STATUS_QUEUED = 'queued'; const STATUS_PROCESSED = 'processed'; const STATUS_ERROR = 'error'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_IN_PROGRESS, self::STATUS_QUEUED, self::STATUS_PROCESSED, self::STATUS_ERROR, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['scheduledAt'] === null) { $invalidProperties[] = "'scheduledAt' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets scheduledAt * * @return \DateTime */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param \DateTime $scheduledAt Datetime for which the email was scheduled * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param \DateTime $createdAt Datetime on which the email was scheduled * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Current status of the scheduled email * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponse.php 0000644 00000026525 15021222673 0015257 0 ustar 00 <?php /** * MasterDetailsResponse * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponse Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'companyName' => 'string', 'id' => 'int', 'currencyCode' => 'string', 'timezone' => 'string', 'billingInfo' => '\Brevo\Client\Model\MasterDetailsResponseBillingInfo', 'planInfo' => '\Brevo\Client\Model\MasterDetailsResponsePlanInfo' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => null, 'companyName' => null, 'id' => 'int64', 'currencyCode' => null, 'timezone' => null, 'billingInfo' => null, 'planInfo' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'companyName' => 'companyName', 'id' => 'id', 'currencyCode' => 'currencyCode', 'timezone' => 'timezone', 'billingInfo' => 'billingInfo', 'planInfo' => 'planInfo' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'companyName' => 'setCompanyName', 'id' => 'setId', 'currencyCode' => 'setCurrencyCode', 'timezone' => 'setTimezone', 'billingInfo' => 'setBillingInfo', 'planInfo' => 'setPlanInfo' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'companyName' => 'getCompanyName', 'id' => 'getId', 'currencyCode' => 'getCurrencyCode', 'timezone' => 'getTimezone', 'billingInfo' => 'getBillingInfo', 'planInfo' => 'getPlanInfo' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['currencyCode'] = isset($data['currencyCode']) ? $data['currencyCode'] : null; $this->container['timezone'] = isset($data['timezone']) ? $data['timezone'] : null; $this->container['billingInfo'] = isset($data['billingInfo']) ? $data['billingInfo'] : null; $this->container['planInfo'] = isset($data['planInfo']) ? $data['planInfo'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email id of master account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Company name of master account organization * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Unique identifier of the master account organization * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets currencyCode * * @return string */ public function getCurrencyCode() { return $this->container['currencyCode']; } /** * Sets currencyCode * * @param string $currencyCode Currency code of the master account organization * * @return $this */ public function setCurrencyCode($currencyCode) { $this->container['currencyCode'] = $currencyCode; return $this; } /** * Gets timezone * * @return string */ public function getTimezone() { return $this->container['timezone']; } /** * Sets timezone * * @param string $timezone Timezone of the master account organization * * @return $this */ public function setTimezone($timezone) { $this->container['timezone'] = $timezone; return $this; } /** * Gets billingInfo * * @return \Brevo\Client\Model\MasterDetailsResponseBillingInfo */ public function getBillingInfo() { return $this->container['billingInfo']; } /** * Sets billingInfo * * @param \Brevo\Client\Model\MasterDetailsResponseBillingInfo $billingInfo billingInfo * * @return $this */ public function setBillingInfo($billingInfo) { $this->container['billingInfo'] = $billingInfo; return $this; } /** * Gets planInfo * * @return \Brevo\Client\Model\MasterDetailsResponsePlanInfo */ public function getPlanInfo() { return $this->container['planInfo']; } /** * Sets planInfo * * @param \Brevo\Client\Model\MasterDetailsResponsePlanInfo $planInfo planInfo * * @return $this */ public function setPlanInfo($planInfo) { $this->container['planInfo'] = $planInfo; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetIps.php 0000644 00000016117 15021222673 0012166 0 ustar 00 <?php /** * GetIps * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetIps Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIps implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getIps'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'ips' => '\Brevo\Client\Model\GetIp[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'ips' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'ips' => 'ips' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'ips' => 'setIps' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'ips' => 'getIps' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['ips'] = isset($data['ips']) ? $data['ips'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['ips'] === null) { $invalidProperties[] = "'ips' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets ips * * @return \Brevo\Client\Model\GetIp[] */ public function getIps() { return $this->container['ips']; } /** * Sets ips * * @param \Brevo\Client\Model\GetIp[] $ips Dedicated IP(s) available on your account * * @return $this */ public function setIps($ips) { $this->container['ips'] = $ips; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountsResponseSubAccounts.php 0000644 00000022755 15021222673 0017122 0 ustar 00 <?php /** * SubAccountsResponseSubAccounts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountsResponseSubAccounts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountsResponseSubAccounts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountsResponse_subAccounts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'companyName' => 'string', 'active' => 'bool', 'createdAt' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'companyName' => null, 'active' => null, 'createdAt' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'companyName' => 'companyName', 'active' => 'active', 'createdAt' => 'createdAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'companyName' => 'setCompanyName', 'active' => 'setActive', 'createdAt' => 'setCreatedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'companyName' => 'getCompanyName', 'active' => 'getActive', 'createdAt' => 'getCreatedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['active'] = isset($data['active']) ? $data['active'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['companyName'] === null) { $invalidProperties[] = "'companyName' can't be null"; } if ($this->container['active'] === null) { $invalidProperties[] = "'active' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id id of the sub-account * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Name of the sub-account company * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets active * * @return bool */ public function getActive() { return $this->container['active']; } /** * Sets active * * @param bool $active Whether the sub-account is active or not * * @return $this */ public function setActive($active) { $this->container['active'] = $active; return $this; } /** * Gets createdAt * * @return int */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param int $createdAt Timestamp when the sub-account was created * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.php 0000644 00000017633 15021222673 0022172 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoCreditsEmails * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoCreditsEmails Class Doc Comment * * @category Class * @description Email credits remaining on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoCreditsEmails implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_credits_emails'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'quantity' => 'int', 'remaining' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'quantity' => 'int64', 'remaining' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'quantity' => 'quantity', 'remaining' => 'remaining' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'quantity' => 'setQuantity', 'remaining' => 'setRemaining' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'quantity' => 'getQuantity', 'remaining' => 'getRemaining' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['quantity'] = isset($data['quantity']) ? $data['quantity'] : null; $this->container['remaining'] = isset($data['remaining']) ? $data['remaining'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets quantity * * @return int */ public function getQuantity() { return $this->container['quantity']; } /** * Sets quantity * * @param int $quantity Quantity of email messaging limits provided * * @return $this */ public function setQuantity($quantity) { $this->container['quantity'] = $quantity; return $this; } /** * Gets remaining * * @return int */ public function getRemaining() { return $this->container['remaining']; } /** * Sets remaining * * @param int $remaining Available email messaging limits for use * * @return $this */ public function setRemaining($remaining) { $this->container['remaining'] = $remaining; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ConversationsMessageFile.php 0000644 00000023776 15021222673 0015746 0 ustar 00 <?php /** * ConversationsMessageFile * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ConversationsMessageFile Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessageFile implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'ConversationsMessage_file'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'filename' => 'string', 'size' => 'int', 'isImage' => 'bool', 'url' => 'string', 'imageInfo' => '\Brevo\Client\Model\ConversationsMessageFileImageInfo' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'filename' => null, 'size' => 'int64', 'isImage' => null, 'url' => 'url', 'imageInfo' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'filename' => 'filename', 'size' => 'size', 'isImage' => 'isImage', 'url' => 'url', 'imageInfo' => 'imageInfo' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'filename' => 'setFilename', 'size' => 'setSize', 'isImage' => 'setIsImage', 'url' => 'setUrl', 'imageInfo' => 'setImageInfo' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'filename' => 'getFilename', 'size' => 'getSize', 'isImage' => 'getIsImage', 'url' => 'getUrl', 'imageInfo' => 'getImageInfo' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['filename'] = isset($data['filename']) ? $data['filename'] : null; $this->container['size'] = isset($data['size']) ? $data['size'] : null; $this->container['isImage'] = isset($data['isImage']) ? $data['isImage'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['imageInfo'] = isset($data['imageInfo']) ? $data['imageInfo'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if (!is_null($this->container['size']) && ($this->container['size'] < 0)) { $invalidProperties[] = "invalid value for 'size', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets filename * * @return string */ public function getFilename() { return $this->container['filename']; } /** * Sets filename * * @param string $filename Name of the file * * @return $this */ public function setFilename($filename) { $this->container['filename'] = $filename; return $this; } /** * Gets size * * @return int */ public function getSize() { return $this->container['size']; } /** * Sets size * * @param int $size Size in bytes * * @return $this */ public function setSize($size) { if (!is_null($size) && ($size < 0)) { throw new \InvalidArgumentException('invalid value for $size when calling ConversationsMessageFile., must be bigger than or equal to 0.'); } $this->container['size'] = $size; return $this; } /** * Gets isImage * * @return bool */ public function getIsImage() { return $this->container['isImage']; } /** * Sets isImage * * @param bool $isImage Whether the file is an image * * @return $this */ public function setIsImage($isImage) { $this->container['isImage'] = $isImage; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the file * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets imageInfo * * @return \Brevo\Client\Model\ConversationsMessageFileImageInfo */ public function getImageInfo() { return $this->container['imageInfo']; } /** * Sets imageInfo * * @param \Brevo\Client\Model\ConversationsMessageFileImageInfo $imageInfo imageInfo * * @return $this */ public function setImageInfo($imageInfo) { $this->container['imageInfo'] = $imageInfo; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetProcess.php 0000644 00000024345 15021222673 0013053 0 ustar 00 <?php /** * GetProcess * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetProcess Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProcess implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getProcess'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'status' => 'string', 'name' => 'string', 'exportUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'status' => null, 'name' => null, 'exportUrl' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'status' => 'status', 'name' => 'name', 'exportUrl' => 'export_url' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'status' => 'setStatus', 'name' => 'setName', 'exportUrl' => 'setExportUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'status' => 'getStatus', 'name' => 'getName', 'exportUrl' => 'getExportUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const STATUS_QUEUED = 'queued'; const STATUS_IN_PROCESS = 'in_process'; const STATUS_COMPLETED = 'completed'; /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_QUEUED, self::STATUS_IN_PROCESS, self::STATUS_COMPLETED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['exportUrl'] = isset($data['exportUrl']) ? $data['exportUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the process * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the process * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Process name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets exportUrl * * @return string */ public function getExportUrl() { return $this->container['exportUrl']; } /** * Sets exportUrl * * @param string $exportUrl URL on which send export the of contacts once the process is completed * * @return $this */ public function setExportUrl($exportUrl) { $this->container['exportUrl'] = $exportUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/MasterDetailsResponseBillingInfoAddress.php 0000644 00000023716 15021222673 0020701 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfoAddress * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * MasterDetailsResponseBillingInfoAddress Class Doc Comment * * @category Class * @description Billing address of master account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfoAddress implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'masterDetailsResponse_billingInfo_address'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'streetAddress' => 'string', 'locality' => 'string', 'postalCode' => 'string', 'stateCode' => 'string', 'countryCode' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'streetAddress' => null, 'locality' => null, 'postalCode' => null, 'stateCode' => null, 'countryCode' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'streetAddress' => 'streetAddress', 'locality' => 'locality', 'postalCode' => 'postalCode', 'stateCode' => 'stateCode', 'countryCode' => 'countryCode' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'streetAddress' => 'setStreetAddress', 'locality' => 'setLocality', 'postalCode' => 'setPostalCode', 'stateCode' => 'setStateCode', 'countryCode' => 'setCountryCode' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'streetAddress' => 'getStreetAddress', 'locality' => 'getLocality', 'postalCode' => 'getPostalCode', 'stateCode' => 'getStateCode', 'countryCode' => 'getCountryCode' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['streetAddress'] = isset($data['streetAddress']) ? $data['streetAddress'] : null; $this->container['locality'] = isset($data['locality']) ? $data['locality'] : null; $this->container['postalCode'] = isset($data['postalCode']) ? $data['postalCode'] : null; $this->container['stateCode'] = isset($data['stateCode']) ? $data['stateCode'] : null; $this->container['countryCode'] = isset($data['countryCode']) ? $data['countryCode'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets streetAddress * * @return string */ public function getStreetAddress() { return $this->container['streetAddress']; } /** * Sets streetAddress * * @param string $streetAddress Street address * * @return $this */ public function setStreetAddress($streetAddress) { $this->container['streetAddress'] = $streetAddress; return $this; } /** * Gets locality * * @return string */ public function getLocality() { return $this->container['locality']; } /** * Sets locality * * @param string $locality Locality * * @return $this */ public function setLocality($locality) { $this->container['locality'] = $locality; return $this; } /** * Gets postalCode * * @return string */ public function getPostalCode() { return $this->container['postalCode']; } /** * Sets postalCode * * @param string $postalCode Postal code * * @return $this */ public function setPostalCode($postalCode) { $this->container['postalCode'] = $postalCode; return $this; } /** * Gets stateCode * * @return string */ public function getStateCode() { return $this->container['stateCode']; } /** * Sets stateCode * * @param string $stateCode State code * * @return $this */ public function setStateCode($stateCode) { $this->container['stateCode'] = $stateCode; return $this; } /** * Gets countryCode * * @return string */ public function getCountryCode() { return $this->container['countryCode']; } /** * Sets countryCode * * @param string $countryCode Country code * * @return $this */ public function setCountryCode($countryCode) { $this->container['countryCode'] = $countryCode; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ModelInterface.php 0000644 00000005400 15021222673 0013645 0 ustar 00 <?php /** * ModelInterface * * PHP version 5 * * @category Class * @package Brevo\Client\Model * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; /** * Interface abstracting model access. * * @package Brevo\Client\Model * @author Swagger Codegen team */ interface ModelInterface { /** * The original name of the model. * * @return string */ public function getModelName(); /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes(); /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats(); /** * Array of attributes where the key is the local name, and the value is the original name * * @return array */ public static function attributeMap(); /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters(); /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters(); /** * Show all the invalid properties with reasons. * * @return array */ public function listInvalidProperties(); /** * Validate all the properties in the model * return true if all passed * * @return bool */ public function valid(); } brevo-php/lib/Model/OrderBilling.php 0000644 00000026213 15021222673 0013345 0 ustar 00 <?php /** * OrderBilling * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * OrderBilling Class Doc Comment * * @category Class * @description Billing details of an order. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderBilling implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'order_billing'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'address' => 'string', 'city' => 'string', 'countryCode' => 'string', 'phone' => 'string', 'postCode' => 'string', 'paymentMethod' => 'string', 'region' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'address' => null, 'city' => null, 'countryCode' => null, 'phone' => null, 'postCode' => null, 'paymentMethod' => null, 'region' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'address' => 'address', 'city' => 'city', 'countryCode' => 'countryCode', 'phone' => 'phone', 'postCode' => 'postCode', 'paymentMethod' => 'paymentMethod', 'region' => 'region' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'address' => 'setAddress', 'city' => 'setCity', 'countryCode' => 'setCountryCode', 'phone' => 'setPhone', 'postCode' => 'setPostCode', 'paymentMethod' => 'setPaymentMethod', 'region' => 'setRegion' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'address' => 'getAddress', 'city' => 'getCity', 'countryCode' => 'getCountryCode', 'phone' => 'getPhone', 'postCode' => 'getPostCode', 'paymentMethod' => 'getPaymentMethod', 'region' => 'getRegion' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['address'] = isset($data['address']) ? $data['address'] : null; $this->container['city'] = isset($data['city']) ? $data['city'] : null; $this->container['countryCode'] = isset($data['countryCode']) ? $data['countryCode'] : null; $this->container['phone'] = isset($data['phone']) ? $data['phone'] : null; $this->container['postCode'] = isset($data['postCode']) ? $data['postCode'] : null; $this->container['paymentMethod'] = isset($data['paymentMethod']) ? $data['paymentMethod'] : null; $this->container['region'] = isset($data['region']) ? $data['region'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets address * * @return string */ public function getAddress() { return $this->container['address']; } /** * Sets address * * @param string $address Full billing address. * * @return $this */ public function setAddress($address) { $this->container['address'] = $address; return $this; } /** * Gets city * * @return string */ public function getCity() { return $this->container['city']; } /** * Sets city * * @param string $city Exact city of the address. * * @return $this */ public function setCity($city) { $this->container['city'] = $city; return $this; } /** * Gets countryCode * * @return string */ public function getCountryCode() { return $this->container['countryCode']; } /** * Sets countryCode * * @param string $countryCode Billing country 2-letter ISO code. * * @return $this */ public function setCountryCode($countryCode) { $this->container['countryCode'] = $countryCode; return $this; } /** * Gets phone * * @return string */ public function getPhone() { return $this->container['phone']; } /** * Sets phone * * @param string $phone Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed. * * @return $this */ public function setPhone($phone) { $this->container['phone'] = $phone; return $this; } /** * Gets postCode * * @return string */ public function getPostCode() { return $this->container['postCode']; } /** * Sets postCode * * @param string $postCode Postcode for delivery and billing. * * @return $this */ public function setPostCode($postCode) { $this->container['postCode'] = $postCode; return $this; } /** * Gets paymentMethod * * @return string */ public function getPaymentMethod() { return $this->container['paymentMethod']; } /** * Sets paymentMethod * * @param string $paymentMethod How the visitor will pay for the item(s), e.g. paypal, check, etc. * * @return $this */ public function setPaymentMethod($paymentMethod) { $this->container['paymentMethod'] = $paymentMethod; return $this; } /** * Gets region * * @return string */ public function getRegion() { return $this->container['region']; } /** * Sets region * * @param string $region Exact region (state/province) for delivery and billing. * * @return $this */ public function setRegion($region) { $this->container['region'] = $region; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateChildAccountStatus.php 0000644 00000023644 15021222673 0015705 0 ustar 00 <?php /** * UpdateChildAccountStatus * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateChildAccountStatus Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChildAccountStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateChildAccountStatus'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'transactionalEmail' => 'bool', 'transactionalSms' => 'bool', 'marketingAutomation' => 'bool', 'smsCampaign' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'transactionalEmail' => null, 'transactionalSms' => null, 'marketingAutomation' => null, 'smsCampaign' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'transactionalEmail' => 'transactionalEmail', 'transactionalSms' => 'transactionalSms', 'marketingAutomation' => 'marketingAutomation', 'smsCampaign' => 'smsCampaign' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'transactionalEmail' => 'setTransactionalEmail', 'transactionalSms' => 'setTransactionalSms', 'marketingAutomation' => 'setMarketingAutomation', 'smsCampaign' => 'setSmsCampaign' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'transactionalEmail' => 'getTransactionalEmail', 'transactionalSms' => 'getTransactionalSms', 'marketingAutomation' => 'getMarketingAutomation', 'smsCampaign' => 'getSmsCampaign' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['transactionalEmail'] = isset($data['transactionalEmail']) ? $data['transactionalEmail'] : null; $this->container['transactionalSms'] = isset($data['transactionalSms']) ? $data['transactionalSms'] : null; $this->container['marketingAutomation'] = isset($data['marketingAutomation']) ? $data['marketingAutomation'] : null; $this->container['smsCampaign'] = isset($data['smsCampaign']) ? $data['smsCampaign'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets transactionalEmail * * @return bool */ public function getTransactionalEmail() { return $this->container['transactionalEmail']; } /** * Sets transactionalEmail * * @param bool $transactionalEmail Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) * * @return $this */ public function setTransactionalEmail($transactionalEmail) { $this->container['transactionalEmail'] = $transactionalEmail; return $this; } /** * Gets transactionalSms * * @return bool */ public function getTransactionalSms() { return $this->container['transactionalSms']; } /** * Sets transactionalSms * * @param bool $transactionalSms Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) * * @return $this */ public function setTransactionalSms($transactionalSms) { $this->container['transactionalSms'] = $transactionalSms; return $this; } /** * Gets marketingAutomation * * @return bool */ public function getMarketingAutomation() { return $this->container['marketingAutomation']; } /** * Sets marketingAutomation * * @param bool $marketingAutomation Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) * * @return $this */ public function setMarketingAutomation($marketingAutomation) { $this->container['marketingAutomation'] = $marketingAutomation; return $this; } /** * Gets smsCampaign * * @return bool */ public function getSmsCampaign() { return $this->container['smsCampaign']; } /** * Sets smsCampaign * * @param bool $smsCampaign Status of SMS Campaign Platform activation for your account (true=enabled, false=disabled) * * @return $this */ public function setSmsCampaign($smsCampaign) { $this->container['smsCampaign'] = $smsCampaign; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetReportsReports.php 0000644 00000041527 15021222673 0014453 0 ustar 00 <?php /** * GetReportsReports * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetReportsReports Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetReportsReports implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getReports_reports'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'date' => '\DateTime', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', 'softBounces' => 'int', 'clicks' => 'int', 'uniqueClicks' => 'int', 'opens' => 'int', 'uniqueOpens' => 'int', 'spamReports' => 'int', 'blocked' => 'int', 'invalid' => 'int', 'unsubscribed' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'date' => 'date', 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', 'softBounces' => 'int64', 'clicks' => 'int64', 'uniqueClicks' => 'int64', 'opens' => 'int64', 'uniqueOpens' => 'int64', 'spamReports' => 'int64', 'blocked' => 'int64', 'invalid' => 'int64', 'unsubscribed' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'date' => 'date', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', 'softBounces' => 'softBounces', 'clicks' => 'clicks', 'uniqueClicks' => 'uniqueClicks', 'opens' => 'opens', 'uniqueOpens' => 'uniqueOpens', 'spamReports' => 'spamReports', 'blocked' => 'blocked', 'invalid' => 'invalid', 'unsubscribed' => 'unsubscribed' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'date' => 'setDate', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', 'softBounces' => 'setSoftBounces', 'clicks' => 'setClicks', 'uniqueClicks' => 'setUniqueClicks', 'opens' => 'setOpens', 'uniqueOpens' => 'setUniqueOpens', 'spamReports' => 'setSpamReports', 'blocked' => 'setBlocked', 'invalid' => 'setInvalid', 'unsubscribed' => 'setUnsubscribed' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'date' => 'getDate', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', 'softBounces' => 'getSoftBounces', 'clicks' => 'getClicks', 'uniqueClicks' => 'getUniqueClicks', 'opens' => 'getOpens', 'uniqueOpens' => 'getUniqueOpens', 'spamReports' => 'getSpamReports', 'blocked' => 'getBlocked', 'invalid' => 'getInvalid', 'unsubscribed' => 'getUnsubscribed' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; $this->container['softBounces'] = isset($data['softBounces']) ? $data['softBounces'] : null; $this->container['clicks'] = isset($data['clicks']) ? $data['clicks'] : null; $this->container['uniqueClicks'] = isset($data['uniqueClicks']) ? $data['uniqueClicks'] : null; $this->container['opens'] = isset($data['opens']) ? $data['opens'] : null; $this->container['uniqueOpens'] = isset($data['uniqueOpens']) ? $data['uniqueOpens'] : null; $this->container['spamReports'] = isset($data['spamReports']) ? $data['spamReports'] : null; $this->container['blocked'] = isset($data['blocked']) ? $data['blocked'] : null; $this->container['invalid'] = isset($data['invalid']) ? $data['invalid'] : null; $this->container['unsubscribed'] = isset($data['unsubscribed']) ? $data['unsubscribed'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['requests'] === null) { $invalidProperties[] = "'requests' can't be null"; } if ($this->container['delivered'] === null) { $invalidProperties[] = "'delivered' can't be null"; } if ($this->container['hardBounces'] === null) { $invalidProperties[] = "'hardBounces' can't be null"; } if ($this->container['softBounces'] === null) { $invalidProperties[] = "'softBounces' can't be null"; } if ($this->container['clicks'] === null) { $invalidProperties[] = "'clicks' can't be null"; } if ($this->container['uniqueClicks'] === null) { $invalidProperties[] = "'uniqueClicks' can't be null"; } if ($this->container['opens'] === null) { $invalidProperties[] = "'opens' can't be null"; } if ($this->container['uniqueOpens'] === null) { $invalidProperties[] = "'uniqueOpens' can't be null"; } if ($this->container['spamReports'] === null) { $invalidProperties[] = "'spamReports' can't be null"; } if ($this->container['blocked'] === null) { $invalidProperties[] = "'blocked' can't be null"; } if ($this->container['invalid'] === null) { $invalidProperties[] = "'invalid' can't be null"; } if ($this->container['unsubscribed'] === null) { $invalidProperties[] = "'unsubscribed' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Date of the statistics * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets requests * * @return int */ public function getRequests() { return $this->container['requests']; } /** * Sets requests * * @param int $requests Number of requests for the date * * @return $this */ public function setRequests($requests) { $this->container['requests'] = $requests; return $this; } /** * Gets delivered * * @return int */ public function getDelivered() { return $this->container['delivered']; } /** * Sets delivered * * @param int $delivered Number of delivered emails for the date * * @return $this */ public function setDelivered($delivered) { $this->container['delivered'] = $delivered; return $this; } /** * Gets hardBounces * * @return int */ public function getHardBounces() { return $this->container['hardBounces']; } /** * Sets hardBounces * * @param int $hardBounces Number of hardbounces for the date * * @return $this */ public function setHardBounces($hardBounces) { $this->container['hardBounces'] = $hardBounces; return $this; } /** * Gets softBounces * * @return int */ public function getSoftBounces() { return $this->container['softBounces']; } /** * Sets softBounces * * @param int $softBounces Number of softbounces for the date * * @return $this */ public function setSoftBounces($softBounces) { $this->container['softBounces'] = $softBounces; return $this; } /** * Gets clicks * * @return int */ public function getClicks() { return $this->container['clicks']; } /** * Sets clicks * * @param int $clicks Number of clicks for the date * * @return $this */ public function setClicks($clicks) { $this->container['clicks'] = $clicks; return $this; } /** * Gets uniqueClicks * * @return int */ public function getUniqueClicks() { return $this->container['uniqueClicks']; } /** * Sets uniqueClicks * * @param int $uniqueClicks Number of unique clicks for the date * * @return $this */ public function setUniqueClicks($uniqueClicks) { $this->container['uniqueClicks'] = $uniqueClicks; return $this; } /** * Gets opens * * @return int */ public function getOpens() { return $this->container['opens']; } /** * Sets opens * * @param int $opens Number of openings for the date * * @return $this */ public function setOpens($opens) { $this->container['opens'] = $opens; return $this; } /** * Gets uniqueOpens * * @return int */ public function getUniqueOpens() { return $this->container['uniqueOpens']; } /** * Sets uniqueOpens * * @param int $uniqueOpens Number of unique openings for the date * * @return $this */ public function setUniqueOpens($uniqueOpens) { $this->container['uniqueOpens'] = $uniqueOpens; return $this; } /** * Gets spamReports * * @return int */ public function getSpamReports() { return $this->container['spamReports']; } /** * Sets spamReports * * @param int $spamReports Number of complaints (spam reports) for the date * * @return $this */ public function setSpamReports($spamReports) { $this->container['spamReports'] = $spamReports; return $this; } /** * Gets blocked * * @return int */ public function getBlocked() { return $this->container['blocked']; } /** * Sets blocked * * @param int $blocked Number of blocked emails for the date * * @return $this */ public function setBlocked($blocked) { $this->container['blocked'] = $blocked; return $this; } /** * Gets invalid * * @return int */ public function getInvalid() { return $this->container['invalid']; } /** * Sets invalid * * @param int $invalid Number of invalid emails for the date * * @return $this */ public function setInvalid($invalid) { $this->container['invalid'] = $invalid; return $this; } /** * Gets unsubscribed * * @return int */ public function getUnsubscribed() { return $this->container['unsubscribed']; } /** * Sets unsubscribed * * @param int $unsubscribed Number of unsubscribed emails for the date * * @return $this */ public function setUnsubscribed($unsubscribed) { $this->container['unsubscribed'] = $unsubscribed; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWhatsappEventReportEvents.php 0000644 00000033551 15021222673 0016606 0 ustar 00 <?php /** * GetWhatsappEventReportEvents * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWhatsappEventReportEvents Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappEventReportEvents implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWhatsappEventReport_events'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'contactNumber' => 'string', 'date' => 'string', 'messageId' => 'string', 'event' => 'string', 'reason' => 'string', 'body' => 'string', 'mediaUrl' => 'string', 'senderNumber' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'contactNumber' => 'mobile', 'date' => null, 'messageId' => null, 'event' => null, 'reason' => null, 'body' => null, 'mediaUrl' => 'url', 'senderNumber' => 'mobile' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'contactNumber' => 'contactNumber', 'date' => 'date', 'messageId' => 'messageId', 'event' => 'event', 'reason' => 'reason', 'body' => 'body', 'mediaUrl' => 'mediaUrl', 'senderNumber' => 'senderNumber' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'contactNumber' => 'setContactNumber', 'date' => 'setDate', 'messageId' => 'setMessageId', 'event' => 'setEvent', 'reason' => 'setReason', 'body' => 'setBody', 'mediaUrl' => 'setMediaUrl', 'senderNumber' => 'setSenderNumber' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'contactNumber' => 'getContactNumber', 'date' => 'getDate', 'messageId' => 'getMessageId', 'event' => 'getEvent', 'reason' => 'getReason', 'body' => 'getBody', 'mediaUrl' => 'getMediaUrl', 'senderNumber' => 'getSenderNumber' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENT_SENT = 'sent'; const EVENT_DELIVERED = 'delivered'; const EVENT_READ = 'read'; const EVENT_ERROR = 'error'; const EVENT_UNSUBSCRIBE = 'unsubscribe'; const EVENT_REPLY = 'reply'; const EVENT_SOFT_BOUNCE = 'soft-bounce'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventAllowableValues() { return [ self::EVENT_SENT, self::EVENT_DELIVERED, self::EVENT_READ, self::EVENT_ERROR, self::EVENT_UNSUBSCRIBE, self::EVENT_REPLY, self::EVENT_SOFT_BOUNCE, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['contactNumber'] = isset($data['contactNumber']) ? $data['contactNumber'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; $this->container['event'] = isset($data['event']) ? $data['event'] : null; $this->container['reason'] = isset($data['reason']) ? $data['reason'] : null; $this->container['body'] = isset($data['body']) ? $data['body'] : null; $this->container['mediaUrl'] = isset($data['mediaUrl']) ? $data['mediaUrl'] : null; $this->container['senderNumber'] = isset($data['senderNumber']) ? $data['senderNumber'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['contactNumber'] === null) { $invalidProperties[] = "'contactNumber' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } if ($this->container['messageId'] === null) { $invalidProperties[] = "'messageId' can't be null"; } if ($this->container['event'] === null) { $invalidProperties[] = "'event' can't be null"; } $allowedValues = $this->getEventAllowableValues(); if (!is_null($this->container['event']) && !in_array($this->container['event'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['senderNumber'] === null) { $invalidProperties[] = "'senderNumber' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets contactNumber * * @return string */ public function getContactNumber() { return $this->container['contactNumber']; } /** * Sets contactNumber * * @param string $contactNumber WhatsApp Number with country code. Example, 85264318721 * * @return $this */ public function setContactNumber($contactNumber) { $this->container['contactNumber'] = $contactNumber; return $this; } /** * Gets date * * @return string */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param string $date UTC date-time on which the event has been generated * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId Message ID which generated the event * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Gets event * * @return string */ public function getEvent() { return $this->container['event']; } /** * Sets event * * @param string $event Event which occurred * * @return $this */ public function setEvent($event) { $allowedValues = $this->getEventAllowableValues(); if (!in_array($event, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['event'] = $event; return $this; } /** * Gets reason * * @return string */ public function getReason() { return $this->container['reason']; } /** * Sets reason * * @param string $reason Reason for the event (will be there in case of `error` and `soft-bounce` events) * * @return $this */ public function setReason($reason) { $this->container['reason'] = $reason; return $this; } /** * Gets body * * @return string */ public function getBody() { return $this->container['body']; } /** * Sets body * * @param string $body Text of the reply (will be there only in case of `reply` event with text) * * @return $this */ public function setBody($body) { $this->container['body'] = $body; return $this; } /** * Gets mediaUrl * * @return string */ public function getMediaUrl() { return $this->container['mediaUrl']; } /** * Sets mediaUrl * * @param string $mediaUrl Url of the media reply (will be there only in case of `reply` event with media) * * @return $this */ public function setMediaUrl($mediaUrl) { $this->container['mediaUrl'] = $mediaUrl; return $this; } /** * Gets senderNumber * * @return string */ public function getSenderNumber() { return $this->container['senderNumber']; } /** * Sets senderNumber * * @param string $senderNumber WhatsApp Number with country code. Example, 85264318721 * * @return $this */ public function setSenderNumber($senderNumber) { $this->container['senderNumber'] = $senderNumber; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/PostSendFailed.php 0000644 00000024435 15021222673 0013641 0 ustar 00 <?php /** * PostSendFailed * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * PostSendFailed Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostSendFailed implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'postSendFailed'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'code' => 'int', 'message' => 'string', 'unexistingEmails' => 'string[]', 'withoutListEmails' => 'string[]', 'blackListedEmails' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'code' => 'int64', 'message' => null, 'unexistingEmails' => 'email', 'withoutListEmails' => 'email', 'blackListedEmails' => 'email' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'code' => 'code', 'message' => 'message', 'unexistingEmails' => 'unexistingEmails', 'withoutListEmails' => 'withoutListEmails', 'blackListedEmails' => 'blackListedEmails' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'code' => 'setCode', 'message' => 'setMessage', 'unexistingEmails' => 'setUnexistingEmails', 'withoutListEmails' => 'setWithoutListEmails', 'blackListedEmails' => 'setBlackListedEmails' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'code' => 'getCode', 'message' => 'getMessage', 'unexistingEmails' => 'getUnexistingEmails', 'withoutListEmails' => 'getWithoutListEmails', 'blackListedEmails' => 'getBlackListedEmails' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['code'] = isset($data['code']) ? $data['code'] : null; $this->container['message'] = isset($data['message']) ? $data['message'] : null; $this->container['unexistingEmails'] = isset($data['unexistingEmails']) ? $data['unexistingEmails'] : null; $this->container['withoutListEmails'] = isset($data['withoutListEmails']) ? $data['withoutListEmails'] : null; $this->container['blackListedEmails'] = isset($data['blackListedEmails']) ? $data['blackListedEmails'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['code'] === null) { $invalidProperties[] = "'code' can't be null"; } if ($this->container['message'] === null) { $invalidProperties[] = "'message' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets code * * @return int */ public function getCode() { return $this->container['code']; } /** * Sets code * * @param int $code Response code * * @return $this */ public function setCode($code) { $this->container['code'] = $code; return $this; } /** * Gets message * * @return string */ public function getMessage() { return $this->container['message']; } /** * Sets message * * @param string $message Response message * * @return $this */ public function setMessage($message) { $this->container['message'] = $message; return $this; } /** * Gets unexistingEmails * * @return string[] */ public function getUnexistingEmails() { return $this->container['unexistingEmails']; } /** * Sets unexistingEmails * * @param string[] $unexistingEmails unexistingEmails * * @return $this */ public function setUnexistingEmails($unexistingEmails) { $this->container['unexistingEmails'] = $unexistingEmails; return $this; } /** * Gets withoutListEmails * * @return string[] */ public function getWithoutListEmails() { return $this->container['withoutListEmails']; } /** * Sets withoutListEmails * * @param string[] $withoutListEmails withoutListEmails * * @return $this */ public function setWithoutListEmails($withoutListEmails) { $this->container['withoutListEmails'] = $withoutListEmails; return $this; } /** * Gets blackListedEmails * * @return string[] */ public function getBlackListedEmails() { return $this->container['blackListedEmails']; } /** * Sets blackListedEmails * * @param string[] $blackListedEmails blackListedEmails * * @return $this */ public function setBlackListedEmails($blackListedEmails) { $this->container['blackListedEmails'] = $blackListedEmails; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetWebhooks.php 0000644 00000016167 15021222673 0013221 0 ustar 00 <?php /** * GetWebhooks * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetWebhooks Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWebhooks implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getWebhooks'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'webhooks' => 'object[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'webhooks' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'webhooks' => 'webhooks' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'webhooks' => 'setWebhooks' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'webhooks' => 'getWebhooks' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['webhooks'] = isset($data['webhooks']) ? $data['webhooks'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['webhooks'] === null) { $invalidProperties[] = "'webhooks' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets webhooks * * @return object[] */ public function getWebhooks() { return $this->container['webhooks']; } /** * Sets webhooks * * @param object[] $webhooks webhooks * * @return $this */ public function setWebhooks($webhooks) { $this->container['webhooks'] = $webhooks; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body6.php 0000644 00000034657 15021222673 0011767 0 ustar 00 <?php /** * Body6 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body6 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body6 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_6'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'duration' => 'int', 'taskTypeId' => 'string', 'date' => '\DateTime', 'notes' => 'string', 'done' => 'bool', 'assignToId' => 'string', 'contactsIds' => 'int[]', 'dealsIds' => 'string[]', 'companiesIds' => 'string[]', 'reminder' => '\Brevo\Client\Model\TaskReminder' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'duration' => 'int64', 'taskTypeId' => null, 'date' => 'date-time', 'notes' => null, 'done' => null, 'assignToId' => null, 'contactsIds' => null, 'dealsIds' => null, 'companiesIds' => null, 'reminder' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'duration' => 'duration', 'taskTypeId' => 'taskTypeId', 'date' => 'date', 'notes' => 'notes', 'done' => 'done', 'assignToId' => 'assignToId', 'contactsIds' => 'contactsIds', 'dealsIds' => 'dealsIds', 'companiesIds' => 'companiesIds', 'reminder' => 'reminder' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'duration' => 'setDuration', 'taskTypeId' => 'setTaskTypeId', 'date' => 'setDate', 'notes' => 'setNotes', 'done' => 'setDone', 'assignToId' => 'setAssignToId', 'contactsIds' => 'setContactsIds', 'dealsIds' => 'setDealsIds', 'companiesIds' => 'setCompaniesIds', 'reminder' => 'setReminder' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'duration' => 'getDuration', 'taskTypeId' => 'getTaskTypeId', 'date' => 'getDate', 'notes' => 'getNotes', 'done' => 'getDone', 'assignToId' => 'getAssignToId', 'contactsIds' => 'getContactsIds', 'dealsIds' => 'getDealsIds', 'companiesIds' => 'getCompaniesIds', 'reminder' => 'getReminder' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['duration'] = isset($data['duration']) ? $data['duration'] : null; $this->container['taskTypeId'] = isset($data['taskTypeId']) ? $data['taskTypeId'] : null; $this->container['date'] = isset($data['date']) ? $data['date'] : null; $this->container['notes'] = isset($data['notes']) ? $data['notes'] : null; $this->container['done'] = isset($data['done']) ? $data['done'] : null; $this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null; $this->container['contactsIds'] = isset($data['contactsIds']) ? $data['contactsIds'] : null; $this->container['dealsIds'] = isset($data['dealsIds']) ? $data['dealsIds'] : null; $this->container['companiesIds'] = isset($data['companiesIds']) ? $data['companiesIds'] : null; $this->container['reminder'] = isset($data['reminder']) ? $data['reminder'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if (!is_null($this->container['duration']) && ($this->container['duration'] < 0)) { $invalidProperties[] = "invalid value for 'duration', must be bigger than or equal to 0."; } if ($this->container['taskTypeId'] === null) { $invalidProperties[] = "'taskTypeId' can't be null"; } if ($this->container['date'] === null) { $invalidProperties[] = "'date' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of task * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets duration * * @return int */ public function getDuration() { return $this->container['duration']; } /** * Sets duration * * @param int $duration Duration of task in milliseconds [1 minute = 60000 ms] * * @return $this */ public function setDuration($duration) { if (!is_null($duration) && ($duration < 0)) { throw new \InvalidArgumentException('invalid value for $duration when calling Body6., must be bigger than or equal to 0.'); } $this->container['duration'] = $duration; return $this; } /** * Gets taskTypeId * * @return string */ public function getTaskTypeId() { return $this->container['taskTypeId']; } /** * Sets taskTypeId * * @param string $taskTypeId Id for type of task e.g Call / Email / Meeting etc. * * @return $this */ public function setTaskTypeId($taskTypeId) { $this->container['taskTypeId'] = $taskTypeId; return $this; } /** * Gets date * * @return \DateTime */ public function getDate() { return $this->container['date']; } /** * Sets date * * @param \DateTime $date Task due date and time * * @return $this */ public function setDate($date) { $this->container['date'] = $date; return $this; } /** * Gets notes * * @return string */ public function getNotes() { return $this->container['notes']; } /** * Sets notes * * @param string $notes Notes added to a task * * @return $this */ public function setNotes($notes) { $this->container['notes'] = $notes; return $this; } /** * Gets done * * @return bool */ public function getDone() { return $this->container['done']; } /** * Sets done * * @param bool $done Task marked as done * * @return $this */ public function setDone($done) { $this->container['done'] = $done; return $this; } /** * Gets assignToId * * @return string */ public function getAssignToId() { return $this->container['assignToId']; } /** * Sets assignToId * * @param string $assignToId User id to whom task is assigned * * @return $this */ public function setAssignToId($assignToId) { $this->container['assignToId'] = $assignToId; return $this; } /** * Gets contactsIds * * @return int[] */ public function getContactsIds() { return $this->container['contactsIds']; } /** * Sets contactsIds * * @param int[] $contactsIds Contact ids for contacts linked to this task * * @return $this */ public function setContactsIds($contactsIds) { $this->container['contactsIds'] = $contactsIds; return $this; } /** * Gets dealsIds * * @return string[] */ public function getDealsIds() { return $this->container['dealsIds']; } /** * Sets dealsIds * * @param string[] $dealsIds Deal ids for deals a task is linked to * * @return $this */ public function setDealsIds($dealsIds) { $this->container['dealsIds'] = $dealsIds; return $this; } /** * Gets companiesIds * * @return string[] */ public function getCompaniesIds() { return $this->container['companiesIds']; } /** * Sets companiesIds * * @param string[] $companiesIds Companies ids for companies a task is linked to * * @return $this */ public function setCompaniesIds($companiesIds) { $this->container['companiesIds'] = $companiesIds; return $this; } /** * Gets reminder * * @return \Brevo\Client\Model\TaskReminder */ public function getReminder() { return $this->container['reminder']; } /** * Sets reminder * * @param \Brevo\Client\Model\TaskReminder $reminder reminder * * @return $this */ public function setReminder($reminder) { $this->container['reminder'] = $reminder; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetFolder.php 0000644 00000025114 15021222673 0012643 0 ustar 00 <?php /** * GetFolder * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetFolder Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFolder implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getFolder'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'totalBlacklisted' => 'int', 'totalSubscribers' => 'int', 'uniqueSubscribers' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'totalBlacklisted' => 'int64', 'totalSubscribers' => 'int64', 'uniqueSubscribers' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'totalBlacklisted' => 'totalBlacklisted', 'totalSubscribers' => 'totalSubscribers', 'uniqueSubscribers' => 'uniqueSubscribers' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'totalBlacklisted' => 'setTotalBlacklisted', 'totalSubscribers' => 'setTotalSubscribers', 'uniqueSubscribers' => 'setUniqueSubscribers' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'totalBlacklisted' => 'getTotalBlacklisted', 'totalSubscribers' => 'getTotalSubscribers', 'uniqueSubscribers' => 'getUniqueSubscribers' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['totalBlacklisted'] = isset($data['totalBlacklisted']) ? $data['totalBlacklisted'] : null; $this->container['totalSubscribers'] = isset($data['totalSubscribers']) ? $data['totalSubscribers'] : null; $this->container['uniqueSubscribers'] = isset($data['uniqueSubscribers']) ? $data['uniqueSubscribers'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['totalBlacklisted'] === null) { $invalidProperties[] = "'totalBlacklisted' can't be null"; } if ($this->container['totalSubscribers'] === null) { $invalidProperties[] = "'totalSubscribers' can't be null"; } if ($this->container['uniqueSubscribers'] === null) { $invalidProperties[] = "'uniqueSubscribers' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the folder * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the folder * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets totalBlacklisted * * @return int */ public function getTotalBlacklisted() { return $this->container['totalBlacklisted']; } /** * Sets totalBlacklisted * * @param int $totalBlacklisted Number of blacklisted contacts in the folder * * @return $this */ public function setTotalBlacklisted($totalBlacklisted) { $this->container['totalBlacklisted'] = $totalBlacklisted; return $this; } /** * Gets totalSubscribers * * @return int */ public function getTotalSubscribers() { return $this->container['totalSubscribers']; } /** * Sets totalSubscribers * * @param int $totalSubscribers Number of contacts in the folder * * @return $this */ public function setTotalSubscribers($totalSubscribers) { $this->container['totalSubscribers'] = $totalSubscribers; return $this; } /** * Gets uniqueSubscribers * * @return int */ public function getUniqueSubscribers() { return $this->container['uniqueSubscribers']; } /** * Sets uniqueSubscribers * * @param int $uniqueSubscribers Number of unique contacts in the folder * * @return $this */ public function setUniqueSubscribers($uniqueSubscribers) { $this->container['uniqueSubscribers'] = $uniqueSubscribers; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetAccountRelayData.php 0000644 00000021230 15021222673 0014606 0 ustar 00 <?php /** * GetAccountRelayData * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetAccountRelayData Class Doc Comment * * @category Class * @description Data regarding the transactional email account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountRelayData implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getAccount_relay_data'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'userName' => 'string', 'relay' => 'string', 'port' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'userName' => 'email', 'relay' => null, 'port' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'userName' => 'userName', 'relay' => 'relay', 'port' => 'port' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'userName' => 'setUserName', 'relay' => 'setRelay', 'port' => 'setPort' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'userName' => 'getUserName', 'relay' => 'getRelay', 'port' => 'getPort' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['userName'] = isset($data['userName']) ? $data['userName'] : null; $this->container['relay'] = isset($data['relay']) ? $data['relay'] : null; $this->container['port'] = isset($data['port']) ? $data['port'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['userName'] === null) { $invalidProperties[] = "'userName' can't be null"; } if ($this->container['relay'] === null) { $invalidProperties[] = "'relay' can't be null"; } if ($this->container['port'] === null) { $invalidProperties[] = "'port' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets userName * * @return string */ public function getUserName() { return $this->container['userName']; } /** * Sets userName * * @param string $userName Email to use as login on transactional platform * * @return $this */ public function setUserName($userName) { $this->container['userName'] = $userName; return $this; } /** * Gets relay * * @return string */ public function getRelay() { return $this->container['relay']; } /** * Sets relay * * @param string $relay URL of the SMTP Relay * * @return $this */ public function setRelay($relay) { $this->container['relay'] = $relay; return $this; } /** * Gets port * * @return int */ public function getPort() { return $this->container['port']; } /** * Sets port * * @param int $port Port used for SMTP Relay * * @return $this */ public function setPort($port) { $this->container['port'] = $port; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateBatchContactsModel.php 0000644 00000017416 15021222673 0015642 0 ustar 00 <?php /** * UpdateBatchContactsModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateBatchContactsModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContactsModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateBatchContactsModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'successIds' => 'int[]', 'failureIds' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'successIds' => 'int64', 'failureIds' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'successIds' => 'successIds', 'failureIds' => 'failureIds' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'successIds' => 'setSuccessIds', 'failureIds' => 'setFailureIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'successIds' => 'getSuccessIds', 'failureIds' => 'getFailureIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['successIds'] = isset($data['successIds']) ? $data['successIds'] : null; $this->container['failureIds'] = isset($data['failureIds']) ? $data['failureIds'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets successIds * * @return int[] */ public function getSuccessIds() { return $this->container['successIds']; } /** * Sets successIds * * @param int[] $successIds successIds * * @return $this */ public function setSuccessIds($successIds) { $this->container['successIds'] = $successIds; return $this; } /** * Gets failureIds * * @return int[] */ public function getFailureIds() { return $this->container['failureIds']; } /** * Sets failureIds * * @param int[] $failureIds failureIds * * @return $this */ public function setFailureIds($failureIds) { $this->container['failureIds'] = $failureIds; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateCategories.php 0000644 00000021771 15021222673 0015351 0 ustar 00 <?php /** * CreateUpdateCategories * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateCategories Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateCategories implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateCategories'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'name' => 'string', 'url' => 'string', 'deletedAt' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'email', 'name' => null, 'url' => null, 'deletedAt' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'url' => 'url', 'deletedAt' => 'deletedAt' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'url' => 'setUrl', 'deletedAt' => 'setDeletedAt' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'url' => 'getUrl', 'deletedAt' => 'getDeletedAt' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['deletedAt'] = isset($data['deletedAt']) ? $data['deletedAt'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique Category ID as saved in the shop * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name **Mandatory in case of creation**. Name of the Category, as displayed in the shop * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL to the category * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets deletedAt * * @return string */ public function getDeletedAt() { return $this->container['deletedAt']; } /** * Sets deletedAt * * @param string $deletedAt UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database * * @return $this */ public function setDeletedAt($deletedAt) { $this->container['deletedAt'] = $deletedAt; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetStatsByDevice.php 0000644 00000023102 15021222673 0014134 0 ustar 00 <?php /** * GetStatsByDevice * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetStatsByDevice Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByDevice implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getStatsByDevice'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'desktop' => 'map[string,\Brevo\Client\Model\GetDeviceBrowserStats]', 'mobile' => 'map[string,\Brevo\Client\Model\GetDeviceBrowserStats]', 'tablet' => 'map[string,\Brevo\Client\Model\GetDeviceBrowserStats]', 'unknown' => 'map[string,\Brevo\Client\Model\GetDeviceBrowserStats]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'desktop' => null, 'mobile' => null, 'tablet' => null, 'unknown' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'desktop' => 'desktop', 'mobile' => 'mobile', 'tablet' => 'tablet', 'unknown' => 'unknown' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'desktop' => 'setDesktop', 'mobile' => 'setMobile', 'tablet' => 'setTablet', 'unknown' => 'setUnknown' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'desktop' => 'getDesktop', 'mobile' => 'getMobile', 'tablet' => 'getTablet', 'unknown' => 'getUnknown' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['desktop'] = isset($data['desktop']) ? $data['desktop'] : null; $this->container['mobile'] = isset($data['mobile']) ? $data['mobile'] : null; $this->container['tablet'] = isset($data['tablet']) ? $data['tablet'] : null; $this->container['unknown'] = isset($data['unknown']) ? $data['unknown'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets desktop * * @return map[string,\Brevo\Client\Model\GetDeviceBrowserStats] */ public function getDesktop() { return $this->container['desktop']; } /** * Sets desktop * * @param map[string,\Brevo\Client\Model\GetDeviceBrowserStats] $desktop Statistics of the campaign on the basis of desktop devices * * @return $this */ public function setDesktop($desktop) { $this->container['desktop'] = $desktop; return $this; } /** * Gets mobile * * @return map[string,\Brevo\Client\Model\GetDeviceBrowserStats] */ public function getMobile() { return $this->container['mobile']; } /** * Sets mobile * * @param map[string,\Brevo\Client\Model\GetDeviceBrowserStats] $mobile Statistics of the campaign on the basis of mobile devices * * @return $this */ public function setMobile($mobile) { $this->container['mobile'] = $mobile; return $this; } /** * Gets tablet * * @return map[string,\Brevo\Client\Model\GetDeviceBrowserStats] */ public function getTablet() { return $this->container['tablet']; } /** * Sets tablet * * @param map[string,\Brevo\Client\Model\GetDeviceBrowserStats] $tablet Statistics of the campaign on the basis of tablet devices * * @return $this */ public function setTablet($tablet) { $this->container['tablet'] = $tablet; return $this; } /** * Gets unknown * * @return map[string,\Brevo\Client\Model\GetDeviceBrowserStats] */ public function getUnknown() { return $this->container['unknown']; } /** * Sets unknown * * @param map[string,\Brevo\Client\Model\GetDeviceBrowserStats] $unknown Statistics of the campaign on the basis of unknown devices * * @return $this */ public function setUnknown($unknown) { $this->container['unknown'] = $unknown; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsClicked.php 0000644 00000020325 15021222673 0021343 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsClicked * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsClicked Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsClicked implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_clicked'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'links' => '\Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'links' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'links' => 'links' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'links' => 'setLinks' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'links' => 'getLinks' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['links'] = isset($data['links']) ? $data['links'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['links'] === null) { $invalidProperties[] = "'links' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets links * * @return \Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[] */ public function getLinks() { return $this->container['links']; } /** * Sets links * * @param \Brevo\Client\Model\GetExtendedContactDetailsStatisticsLinks[] $links Listing of the clicked links for the campaign * * @return $this */ public function setLinks($links) { $this->container['links'] = $links; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AddCredits.php 0000644 00000017150 15021222673 0012777 0 ustar 00 <?php /** * AddCredits * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AddCredits Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddCredits implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'addCredits'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'sms' => 'int', 'email' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'sms' => 'int64', 'email' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'sms' => 'sms', 'email' => 'email' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'sms' => 'setSms', 'email' => 'setEmail' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'sms' => 'getSms', 'email' => 'getEmail' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['sms'] = isset($data['sms']) ? $data['sms'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets sms * * @return int */ public function getSms() { return $this->container['sms']; } /** * Sets sms * * @param int $sms Required if email credits are empty. SMS credits to be added to the child account * * @return $this */ public function setSms($sms) { $this->container['sms'] = $sms; return $this; } /** * Gets email * * @return int */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param int $email Required if sms credits are empty. Email credits to be added to the child account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse200.php 0000644 00000016063 15021222673 0014152 0 ustar 00 <?php /** * InlineResponse200 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse200 Class Doc Comment * * @category Class * @description Created company id * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse200 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_200'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique company id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse2013.php 0000644 00000016273 15021222673 0014241 0 ustar 00 <?php /** * InlineResponse2013 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse2013 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2013 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_201_3'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'messageId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'messageId' => 'uuidv4' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'messageId' => 'messageId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'messageId' => 'setMessageId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'messageId' => 'getMessageId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['messageId'] === null) { $invalidProperties[] = "'messageId' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets messageId * * @return string */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param string $messageId messageId of sent message * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/BlockDomain.php 0000644 00000016135 15021222673 0013155 0 ustar 00 <?php /** * BlockDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * BlockDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class BlockDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'blockDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['domain'] === null) { $invalidProperties[] = "'domain' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain name of the domain to be blocked * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SubAccountDetailsResponsePlanInfoFeatures.php 0000644 00000021670 15021222673 0021214 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeatures * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SubAccountDetailsResponsePlanInfoFeatures Class Doc Comment * * @category Class * @description Features available on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeatures implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'subAccountDetailsResponse_planInfo_features'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'inbox' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesInbox', 'landingPage' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesLandingPage', 'users' => '\Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesUsers' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'inbox' => null, 'landingPage' => null, 'users' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'inbox' => 'inbox', 'landingPage' => 'landingPage', 'users' => 'users' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'inbox' => 'setInbox', 'landingPage' => 'setLandingPage', 'users' => 'setUsers' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'inbox' => 'getInbox', 'landingPage' => 'getLandingPage', 'users' => 'getUsers' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['inbox'] = isset($data['inbox']) ? $data['inbox'] : null; $this->container['landingPage'] = isset($data['landingPage']) ? $data['landingPage'] : null; $this->container['users'] = isset($data['users']) ? $data['users'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets inbox * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesInbox */ public function getInbox() { return $this->container['inbox']; } /** * Sets inbox * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesInbox $inbox inbox * * @return $this */ public function setInbox($inbox) { $this->container['inbox'] = $inbox; return $this; } /** * Gets landingPage * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesLandingPage */ public function getLandingPage() { return $this->container['landingPage']; } /** * Sets landingPage * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesLandingPage $landingPage landingPage * * @return $this */ public function setLandingPage($landingPage) { $this->container['landingPage'] = $landingPage; return $this; } /** * Gets users * * @return \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesUsers */ public function getUsers() { return $this->container['users']; } /** * Sets users * * @param \Brevo\Client\Model\SubAccountDetailsResponsePlanInfoFeaturesUsers $users users * * @return $this */ public function setUsers($users) { $this->container['users'] = $users; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedList.php 0000644 00000023175 15021222673 0014031 0 ustar 00 <?php /** * GetExtendedList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \Brevo\Client\ObjectSerializer; /** * GetExtendedList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedList extends GetList { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'folderId' => 'int', 'createdAt' => 'string', 'campaignStats' => '\Brevo\Client\Model\GetExtendedListCampaignStats[]', 'dynamicList' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'folderId' => 'int64', 'createdAt' => null, 'campaignStats' => null, 'dynamicList' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes + parent::swaggerTypes(); } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats + parent::swaggerFormats(); } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'folderId' => 'folderId', 'createdAt' => 'createdAt', 'campaignStats' => 'campaignStats', 'dynamicList' => 'dynamicList' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'folderId' => 'setFolderId', 'createdAt' => 'setCreatedAt', 'campaignStats' => 'setCampaignStats', 'dynamicList' => 'setDynamicList' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'folderId' => 'getFolderId', 'createdAt' => 'getCreatedAt', 'campaignStats' => 'getCampaignStats', 'dynamicList' => 'getDynamicList' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return parent::attributeMap() + self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return parent::setters() + self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return parent::getters() + self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { parent::__construct($data); $this->container['folderId'] = isset($data['folderId']) ? $data['folderId'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['campaignStats'] = isset($data['campaignStats']) ? $data['campaignStats'] : null; $this->container['dynamicList'] = isset($data['dynamicList']) ? $data['dynamicList'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = parent::listInvalidProperties(); if ($this->container['folderId'] === null) { $invalidProperties[] = "'folderId' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets folderId * * @return int */ public function getFolderId() { return $this->container['folderId']; } /** * Sets folderId * * @param int $folderId ID of the folder * * @return $this */ public function setFolderId($folderId) { $this->container['folderId'] = $folderId; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets campaignStats * * @return \Brevo\Client\Model\GetExtendedListCampaignStats[] */ public function getCampaignStats() { return $this->container['campaignStats']; } /** * Sets campaignStats * * @param \Brevo\Client\Model\GetExtendedListCampaignStats[] $campaignStats campaignStats * * @return $this */ public function setCampaignStats($campaignStats) { $this->container['campaignStats'] = $campaignStats; return $this; } /** * Gets dynamicList * * @return bool */ public function getDynamicList() { return $this->container['dynamicList']; } /** * Sets dynamicList * * @param bool $dynamicList Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) * * @return $this */ public function setDynamicList($dynamicList) { $this->container['dynamicList'] = $dynamicList; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetCampaignOverview.php 0000644 00000046133 15021222673 0014702 0 ustar 00 <?php /** * GetCampaignOverview * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetCampaignOverview Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignOverview implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getCampaignOverview'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'subject' => 'string', 'previewText' => 'string', 'type' => 'string', 'status' => 'string', 'scheduledAt' => 'string', 'abTesting' => 'bool', 'subjectA' => 'string', 'subjectB' => 'string', 'splitRule' => 'int', 'winnerCriteria' => 'string', 'winnerDelay' => 'int', 'sendAtBestTime' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'subject' => null, 'previewText' => null, 'type' => null, 'status' => null, 'scheduledAt' => null, 'abTesting' => null, 'subjectA' => null, 'subjectB' => null, 'splitRule' => null, 'winnerCriteria' => null, 'winnerDelay' => null, 'sendAtBestTime' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'subject' => 'subject', 'previewText' => 'previewText', 'type' => 'type', 'status' => 'status', 'scheduledAt' => 'scheduledAt', 'abTesting' => 'abTesting', 'subjectA' => 'subjectA', 'subjectB' => 'subjectB', 'splitRule' => 'splitRule', 'winnerCriteria' => 'winnerCriteria', 'winnerDelay' => 'winnerDelay', 'sendAtBestTime' => 'sendAtBestTime' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'subject' => 'setSubject', 'previewText' => 'setPreviewText', 'type' => 'setType', 'status' => 'setStatus', 'scheduledAt' => 'setScheduledAt', 'abTesting' => 'setAbTesting', 'subjectA' => 'setSubjectA', 'subjectB' => 'setSubjectB', 'splitRule' => 'setSplitRule', 'winnerCriteria' => 'setWinnerCriteria', 'winnerDelay' => 'setWinnerDelay', 'sendAtBestTime' => 'setSendAtBestTime' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'subject' => 'getSubject', 'previewText' => 'getPreviewText', 'type' => 'getType', 'status' => 'getStatus', 'scheduledAt' => 'getScheduledAt', 'abTesting' => 'getAbTesting', 'subjectA' => 'getSubjectA', 'subjectB' => 'getSubjectB', 'splitRule' => 'getSplitRule', 'winnerCriteria' => 'getWinnerCriteria', 'winnerDelay' => 'getWinnerDelay', 'sendAtBestTime' => 'getSendAtBestTime' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_CLASSIC = 'classic'; const TYPE_TRIGGER = 'trigger'; const STATUS_DRAFT = 'draft'; const STATUS_SENT = 'sent'; const STATUS_ARCHIVE = 'archive'; const STATUS_QUEUED = 'queued'; const STATUS_SUSPENDED = 'suspended'; const STATUS_IN_PROCESS = 'in_process'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_CLASSIC, self::TYPE_TRIGGER, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_DRAFT, self::STATUS_SENT, self::STATUS_ARCHIVE, self::STATUS_QUEUED, self::STATUS_SUSPENDED, self::STATUS_IN_PROCESS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['previewText'] = isset($data['previewText']) ? $data['previewText'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['abTesting'] = isset($data['abTesting']) ? $data['abTesting'] : null; $this->container['subjectA'] = isset($data['subjectA']) ? $data['subjectA'] : null; $this->container['subjectB'] = isset($data['subjectB']) ? $data['subjectB'] : null; $this->container['splitRule'] = isset($data['splitRule']) ? $data['splitRule'] : null; $this->container['winnerCriteria'] = isset($data['winnerCriteria']) ? $data['winnerCriteria'] : null; $this->container['winnerDelay'] = isset($data['winnerDelay']) ? $data['winnerDelay'] : null; $this->container['sendAtBestTime'] = isset($data['sendAtBestTime']) ? $data['sendAtBestTime'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets previewText * * @return string */ public function getPreviewText() { return $this->container['previewText']; } /** * Sets previewText * * @param string $previewText Preview text or preheader of the email campaign * * @return $this */ public function setPreviewText($previewText) { $this->container['previewText'] = $previewText; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of campaign * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the campaign * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets abTesting * * @return bool */ public function getAbTesting() { return $this->container['abTesting']; } /** * Sets abTesting * * @param bool $abTesting Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. * * @return $this */ public function setAbTesting($abTesting) { $this->container['abTesting'] = $abTesting; return $this; } /** * Gets subjectA * * @return string */ public function getSubjectA() { return $this->container['subjectA']; } /** * Sets subjectA * * @param string $subjectA Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectA($subjectA) { $this->container['subjectA'] = $subjectA; return $this; } /** * Gets subjectB * * @return string */ public function getSubjectB() { return $this->container['subjectB']; } /** * Sets subjectB * * @param string $subjectB Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectB($subjectB) { $this->container['subjectB'] = $subjectB; return $this; } /** * Gets splitRule * * @return int */ public function getSplitRule() { return $this->container['splitRule']; } /** * Sets splitRule * * @param int $splitRule The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSplitRule($splitRule) { $this->container['splitRule'] = $splitRule; return $this; } /** * Gets winnerCriteria * * @return string */ public function getWinnerCriteria() { return $this->container['winnerCriteria']; } /** * Sets winnerCriteria * * @param string $winnerCriteria Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerCriteria($winnerCriteria) { $this->container['winnerCriteria'] = $winnerCriteria; return $this; } /** * Gets winnerDelay * * @return int */ public function getWinnerDelay() { return $this->container['winnerDelay']; } /** * Sets winnerDelay * * @param int $winnerDelay The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerDelay($winnerDelay) { $this->container['winnerDelay'] = $winnerDelay; return $this; } /** * Gets sendAtBestTime * * @return bool */ public function getSendAtBestTime() { return $this->container['sendAtBestTime']; } /** * Sets sendAtBestTime * * @param bool $sendAtBestTime It is true if you have chosen to send your campaign at best time, otherwise it is false * * @return $this */ public function setSendAtBestTime($sendAtBestTime) { $this->container['sendAtBestTime'] = $sendAtBestTime; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/SendWhatsappMessage.php 0000644 00000023067 15021222673 0014703 0 ustar 00 <?php /** * SendWhatsappMessage * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * SendWhatsappMessage Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendWhatsappMessage implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'sendWhatsappMessage'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'templateId' => 'int', 'text' => 'string', 'senderNumber' => 'string', 'contactNumbers' => 'string[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'templateId' => null, 'text' => null, 'senderNumber' => 'mobile', 'contactNumbers' => 'mobile' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'templateId' => 'templateId', 'text' => 'text', 'senderNumber' => 'senderNumber', 'contactNumbers' => 'contactNumbers' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'templateId' => 'setTemplateId', 'text' => 'setText', 'senderNumber' => 'setSenderNumber', 'contactNumbers' => 'setContactNumbers' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'templateId' => 'getTemplateId', 'text' => 'getText', 'senderNumber' => 'getSenderNumber', 'contactNumbers' => 'getContactNumbers' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['senderNumber'] = isset($data['senderNumber']) ? $data['senderNumber'] : null; $this->container['contactNumbers'] = isset($data['contactNumbers']) ? $data['contactNumbers'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['senderNumber'] === null) { $invalidProperties[] = "'senderNumber' can't be null"; } if ($this->container['contactNumbers'] === null) { $invalidProperties[] = "'contactNumbers' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets templateId * * @return int */ public function getTemplateId() { return $this->container['templateId']; } /** * Sets templateId * * @param int $templateId ID of the template to send * * @return $this */ public function setTemplateId($templateId) { $this->container['templateId'] = $templateId; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text Text to be sent as message body (will be overridden if templateId is passed in the same request) * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Gets senderNumber * * @return string */ public function getSenderNumber() { return $this->container['senderNumber']; } /** * Sets senderNumber * * @param string $senderNumber WhatsApp Number with country code. Example, 85264318721 * * @return $this */ public function setSenderNumber($senderNumber) { $this->container['senderNumber'] = $senderNumber; return $this; } /** * Gets contactNumbers * * @return string[] */ public function getContactNumbers() { return $this->container['contactNumbers']; } /** * Sets contactNumbers * * @param string[] $contactNumbers List of phone numbers of the contacts * * @return $this */ public function setContactNumbers($contactNumbers) { $this->container['contactNumbers'] = $contactNumbers; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AddContactToList.php 0000644 00000017674 15021222673 0014147 0 ustar 00 <?php /** * AddContactToList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AddContactToList Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddContactToList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'addContactToList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'emails' => 'string[]', 'ids' => 'int[]' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'emails' => 'email', 'ids' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'emails' => 'emails', 'ids' => 'ids' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'emails' => 'setEmails', 'ids' => 'setIds' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'emails' => 'getEmails', 'ids' => 'getIds' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['emails'] = isset($data['emails']) ? $data['emails'] : null; $this->container['ids'] = isset($data['ids']) ? $data['ids'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets emails * * @return string[] */ public function getEmails() { return $this->container['emails']; } /** * Sets emails * * @param string[] $emails Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. * * @return $this */ public function setEmails($emails) { $this->container['emails'] = $emails; return $this; } /** * Gets ids * * @return int[] */ public function getIds() { return $this->container['ids']; } /** * Sets ids * * @param int[] $ids Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. * * @return $this */ public function setIds($ids) { $this->container['ids'] = $ids; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetChildAccountCreationStatus.php 0000644 00000016761 15021222673 0016671 0 ustar 00 <?php /** * GetChildAccountCreationStatus * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetChildAccountCreationStatus Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildAccountCreationStatus implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getChildAccountCreationStatus'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'childAccountCreated' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'childAccountCreated' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'childAccountCreated' => 'childAccountCreated' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'childAccountCreated' => 'setChildAccountCreated' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'childAccountCreated' => 'getChildAccountCreated' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['childAccountCreated'] = isset($data['childAccountCreated']) ? $data['childAccountCreated'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['childAccountCreated'] === null) { $invalidProperties[] = "'childAccountCreated' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets childAccountCreated * * @return bool */ public function getChildAccountCreated() { return $this->container['childAccountCreated']; } /** * Sets childAccountCreated * * @param bool $childAccountCreated Status of child account creation whether it is successfully created (exists) or not. * * @return $this */ public function setChildAccountCreated($childAccountCreated) { $this->container['childAccountCreated'] = $childAccountCreated; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateWebhook.php 0000644 00000026355 15021222673 0013541 0 ustar 00 <?php /** * UpdateWebhook * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateWebhook Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateWebhook implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateWebhook'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'url' => 'string', 'description' => 'string', 'events' => 'string[]', 'domain' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'url' => 'url', 'description' => null, 'events' => null, 'domain' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'url' => 'url', 'description' => 'description', 'events' => 'events', 'domain' => 'domain' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'url' => 'setUrl', 'description' => 'setDescription', 'events' => 'setEvents', 'domain' => 'setDomain' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'url' => 'getUrl', 'description' => 'getDescription', 'events' => 'getEvents', 'domain' => 'getDomain' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENTS_SENT = 'sent'; const EVENTS_HARD_BOUNCE = 'hardBounce'; const EVENTS_SOFT_BOUNCE = 'softBounce'; const EVENTS_BLOCKED = 'blocked'; const EVENTS_SPAM = 'spam'; const EVENTS_DELIVERED = 'delivered'; const EVENTS_REQUEST = 'request'; const EVENTS_CLICK = 'click'; const EVENTS_INVALID = 'invalid'; const EVENTS_DEFERRED = 'deferred'; const EVENTS_OPENED = 'opened'; const EVENTS_UNIQUE_OPENED = 'uniqueOpened'; const EVENTS_UNSUBSCRIBED = 'unsubscribed'; const EVENTS_LIST_ADDITION = 'listAddition'; const EVENTS_CONTACT_UPDATED = 'contactUpdated'; const EVENTS_CONTACT_DELETED = 'contactDeleted'; const EVENTS_INBOUND_EMAIL_PROCESSED = 'inboundEmailProcessed'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventsAllowableValues() { return [ self::EVENTS_SENT, self::EVENTS_HARD_BOUNCE, self::EVENTS_SOFT_BOUNCE, self::EVENTS_BLOCKED, self::EVENTS_SPAM, self::EVENTS_DELIVERED, self::EVENTS_REQUEST, self::EVENTS_CLICK, self::EVENTS_INVALID, self::EVENTS_DEFERRED, self::EVENTS_OPENED, self::EVENTS_UNIQUE_OPENED, self::EVENTS_UNSUBSCRIBED, self::EVENTS_LIST_ADDITION, self::EVENTS_CONTACT_UPDATED, self::EVENTS_CONTACT_DELETED, self::EVENTS_INBOUND_EMAIL_PROCESSED, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['description'] = isset($data['description']) ? $data['description'] : null; $this->container['events'] = isset($data['events']) ? $data['events'] : null; $this->container['domain'] = isset($data['domain']) ? $data['domain'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the webhook * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets description * * @return string */ public function getDescription() { return $this->container['description']; } /** * Sets description * * @param string $description Description of the webhook * * @return $this */ public function setDescription($description) { $this->container['description'] = $description; return $this; } /** * Gets events * * @return string[] */ public function getEvents() { return $this->container['events']; } /** * Sets events * * @param string[] $events - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` * * @return $this */ public function setEvents($events) { $allowedValues = $this->getEventsAllowableValues(); if (!is_null($events) && array_diff($events, $allowedValues)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'events', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['events'] = $events; return $this; } /** * Gets domain * * @return string */ public function getDomain() { return $this->container['domain']; } /** * Sets domain * * @param string $domain Inbound domain of webhook, used in case of event type `inbound` * * @return $this */ public function setDomain($domain) { $this->container['domain'] = $domain; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ExportWebhooksHistory.php 0000644 00000035513 15021222673 0015341 0 ustar 00 <?php /** * ExportWebhooksHistory * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ExportWebhooksHistory Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ExportWebhooksHistory implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'exportWebhooksHistory'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'days' => 'int', 'startDate' => 'string', 'endDate' => 'string', 'sort' => 'string', 'event' => 'string', 'notifyURL' => 'string', 'webhookId' => 'int', 'email' => 'string', 'messageId' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'days' => null, 'startDate' => null, 'endDate' => null, 'sort' => null, 'event' => null, 'notifyURL' => null, 'webhookId' => null, 'email' => null, 'messageId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'days' => 'days', 'startDate' => 'startDate', 'endDate' => 'endDate', 'sort' => 'sort', 'event' => 'event', 'notifyURL' => 'notifyURL', 'webhookId' => 'webhookId', 'email' => 'email', 'messageId' => 'messageId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'days' => 'setDays', 'startDate' => 'setStartDate', 'endDate' => 'setEndDate', 'sort' => 'setSort', 'event' => 'setEvent', 'notifyURL' => 'setNotifyURL', 'webhookId' => 'setWebhookId', 'email' => 'setEmail', 'messageId' => 'setMessageId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'days' => 'getDays', 'startDate' => 'getStartDate', 'endDate' => 'getEndDate', 'sort' => 'getSort', 'event' => 'getEvent', 'notifyURL' => 'getNotifyURL', 'webhookId' => 'getWebhookId', 'email' => 'getEmail', 'messageId' => 'getMessageId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const EVENT_INVALID_PARAMETER = 'invalid_parameter'; const EVENT_MISSING_PARAMETER = 'missing_parameter'; const EVENT_HARD_BOUNCE = 'hardBounce'; const EVENT_SOFT_BOUNCE = 'softBounce'; const EVENT_DELIVERED = 'delivered\"'; const EVENT_SPAM = 'spam'; const EVENT_REQUEST = 'request'; const EVENT_OPENED = 'opened'; const EVENT_CLICK = 'click'; const EVENT_INVALID = 'invalid'; const EVENT_DEFERRED = 'deferred'; const EVENT_BLOCKED = 'blocked'; const EVENT_UNSUBSCRIBED = 'unsubscribed'; const EVENT_ERROR = 'error'; const EVENT_UNIQUE_OPENED = 'uniqueOpened'; const EVENT_LOADED_BY_PROXY = 'loadedByProxy'; const EVENT_ALL_EVENTS = 'allEvents'; /** * Gets allowable values of the enum * * @return string[] */ public function getEventAllowableValues() { return [ self::EVENT_INVALID_PARAMETER, self::EVENT_MISSING_PARAMETER, self::EVENT_HARD_BOUNCE, self::EVENT_SOFT_BOUNCE, self::EVENT_DELIVERED, self::EVENT_SPAM, self::EVENT_REQUEST, self::EVENT_OPENED, self::EVENT_CLICK, self::EVENT_INVALID, self::EVENT_DEFERRED, self::EVENT_BLOCKED, self::EVENT_UNSUBSCRIBED, self::EVENT_ERROR, self::EVENT_UNIQUE_OPENED, self::EVENT_LOADED_BY_PROXY, self::EVENT_ALL_EVENTS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['days'] = isset($data['days']) ? $data['days'] : null; $this->container['startDate'] = isset($data['startDate']) ? $data['startDate'] : null; $this->container['endDate'] = isset($data['endDate']) ? $data['endDate'] : null; $this->container['sort'] = isset($data['sort']) ? $data['sort'] : null; $this->container['event'] = isset($data['event']) ? $data['event'] : null; $this->container['notifyURL'] = isset($data['notifyURL']) ? $data['notifyURL'] : null; $this->container['webhookId'] = isset($data['webhookId']) ? $data['webhookId'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['event'] === null) { $invalidProperties[] = "'event' can't be null"; } $allowedValues = $this->getEventAllowableValues(); if (!is_null($this->container['event']) && !in_array($this->container['event'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['notifyURL'] === null) { $invalidProperties[] = "'notifyURL' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets days * * @return int */ public function getDays() { return $this->container['days']; } /** * Sets days * * @param int $days Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ * * @return $this */ public function setDays($days) { $this->container['days'] = $days; return $this; } /** * Gets startDate * * @return string */ public function getStartDate() { return $this->container['startDate']; } /** * Sets startDate * * @param string $startDate Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate * * @return $this */ public function setStartDate($startDate) { $this->container['startDate'] = $startDate; return $this; } /** * Gets endDate * * @return string */ public function getEndDate() { return $this->container['endDate']; } /** * Sets endDate * * @param string $endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate * * @return $this */ public function setEndDate($endDate) { $this->container['endDate'] = $endDate; return $this; } /** * Gets sort * * @return string */ public function getSort() { return $this->container['sort']; } /** * Sets sort * * @param string $sort Sorting order of records (asc or desc) * * @return $this */ public function setSort($sort) { $this->container['sort'] = $sort; return $this; } /** * Gets event * * @return string */ public function getEvent() { return $this->container['event']; } /** * Sets event * * @param string $event Filter the history for a specific event type * * @return $this */ public function setEvent($event) { $allowedValues = $this->getEventAllowableValues(); if (!in_array($event, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'event', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['event'] = $event; return $this; } /** * Gets notifyURL * * @return string */ public function getNotifyURL() { return $this->container['notifyURL']; } /** * Sets notifyURL * * @param string $notifyURL Webhook URL to receive CSV file link * * @return $this */ public function setNotifyURL($notifyURL) { $this->container['notifyURL'] = $notifyURL; return $this; } /** * Gets webhookId * * @return int */ public function getWebhookId() { return $this->container['webhookId']; } /** * Sets webhookId * * @param int $webhookId Filter the history for a specific webhook id * * @return $this */ public function setWebhookId($webhookId) { $this->container['webhookId'] = $webhookId; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Filter the history for a specific email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets messageId * * @return int */ public function getMessageId() { return $this->container['messageId']; } /** * Sets messageId * * @param int $messageId Filter the history for a specific message id * * @return $this */ public function setMessageId($messageId) { $this->container['messageId'] = $messageId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateBatchCategory.php 0000644 00000020232 15021222673 0015772 0 ustar 00 <?php /** * CreateUpdateBatchCategory * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateBatchCategory Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchCategory implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateBatchCategory'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'categories' => '\Brevo\Client\Model\CreateUpdateCategories[]', 'updateEnabled' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'categories' => null, 'updateEnabled' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'categories' => 'categories', 'updateEnabled' => 'updateEnabled' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'categories' => 'setCategories', 'updateEnabled' => 'setUpdateEnabled' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'categories' => 'getCategories', 'updateEnabled' => 'getUpdateEnabled' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['categories'] = isset($data['categories']) ? $data['categories'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['categories'] === null) { $invalidProperties[] = "'categories' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets categories * * @return \Brevo\Client\Model\CreateUpdateCategories[] */ public function getCategories() { return $this->container['categories']; } /** * Sets categories * * @param \Brevo\Client\Model\CreateUpdateCategories[] $categories array of categories objects * * @return $this */ public function setCategories($categories) { $this->container['categories'] = $categories; return $this; } /** * Gets updateEnabled * * @return bool */ public function getUpdateEnabled() { return $this->container['updateEnabled']; } /** * Sets updateEnabled * * @param bool $updateEnabled Facilitate to update the existing categories in the same request (updateEnabled = true) * * @return $this */ public function setUpdateEnabled($updateEnabled) { $this->container['updateEnabled'] = $updateEnabled; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetStatsByDomain.php 0000644 00000014673 15021222673 0014161 0 ustar 00 <?php /** * GetStatsByDomain * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetStatsByDomain Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByDomain implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getStatsByDomain'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/Body10.php 0000644 00000023043 15021222673 0012025 0 ustar 00 <?php /** * Body10 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * Body10 Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body10 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'body_10'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'visitorId' => 'string', 'text' => 'string', 'agentId' => 'string', 'groupId' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'visitorId' => null, 'text' => null, 'agentId' => null, 'groupId' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'visitorId' => 'visitorId', 'text' => 'text', 'agentId' => 'agentId', 'groupId' => 'groupId' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'visitorId' => 'setVisitorId', 'text' => 'setText', 'agentId' => 'setAgentId', 'groupId' => 'setGroupId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'visitorId' => 'getVisitorId', 'text' => 'getText', 'agentId' => 'getAgentId', 'groupId' => 'getGroupId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['visitorId'] = isset($data['visitorId']) ? $data['visitorId'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['agentId'] = isset($data['agentId']) ? $data['agentId'] : null; $this->container['groupId'] = isset($data['groupId']) ? $data['groupId'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['visitorId'] === null) { $invalidProperties[] = "'visitorId' can't be null"; } if ($this->container['text'] === null) { $invalidProperties[] = "'text' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets visitorId * * @return string */ public function getVisitorId() { return $this->container['visitorId']; } /** * Sets visitorId * * @param string $visitorId visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> * * @return $this */ public function setVisitorId($visitorId) { $this->container['visitorId'] = $visitorId; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text message text * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Gets agentId * * @return string */ public function getAgentId() { return $this->container['agentId']; } /** * Sets agentId * * @param string $agentId agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. * * @return $this */ public function setAgentId($agentId) { $this->container['agentId'] = $agentId; return $this; } /** * Gets groupId * * @return string */ public function getGroupId() { return $this->container['groupId']; } /** * Sets groupId * * @param string $groupId group ID. It can be found on group’s page. Optional if `agentId` is set. * * @return $this */ public function setGroupId($groupId) { $this->container['groupId'] = $groupId; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.php 0000644 00000021425 15021222673 0027030 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_unsubscriptions_userUnsubscription'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'campaignId' => 'int', 'eventTime' => 'string', 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'campaignId' => 'int64', 'eventTime' => null, 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'campaignId' => 'campaignId', 'eventTime' => 'eventTime', 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'campaignId' => 'setCampaignId', 'eventTime' => 'setEventTime', 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'campaignId' => 'getCampaignId', 'eventTime' => 'getEventTime', 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['campaignId'] = isset($data['campaignId']) ? $data['campaignId'] : null; $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['campaignId'] === null) { $invalidProperties[] = "'campaignId' can't be null"; } if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets campaignId * * @return int */ public function getCampaignId() { return $this->container['campaignId']; } /** * Sets campaignId * * @param int $campaignId ID of the campaign which generated the event * * @return $this */ public function setCampaignId($campaignId) { $this->container['campaignId'] = $campaignId; return $this; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has unsubscribed * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/RequestContactImport.php 0000644 00000036307 15021222673 0015135 0 ustar 00 <?php /** * RequestContactImport * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * RequestContactImport Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImport implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'requestContactImport'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'fileUrl' => 'string', 'fileBody' => 'string', 'jsonBody' => '\Brevo\Client\Model\RequestContactImportJsonBody[]', 'listIds' => 'int[]', 'notifyUrl' => 'string', 'newList' => '\Brevo\Client\Model\RequestContactImportNewList', 'emailBlacklist' => 'bool', 'smsBlacklist' => 'bool', 'updateExistingContacts' => 'bool', 'emptyContactsAttributes' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'fileUrl' => 'url', 'fileBody' => null, 'jsonBody' => null, 'listIds' => 'int64', 'notifyUrl' => 'url', 'newList' => null, 'emailBlacklist' => null, 'smsBlacklist' => null, 'updateExistingContacts' => null, 'emptyContactsAttributes' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'fileUrl' => 'fileUrl', 'fileBody' => 'fileBody', 'jsonBody' => 'jsonBody', 'listIds' => 'listIds', 'notifyUrl' => 'notifyUrl', 'newList' => 'newList', 'emailBlacklist' => 'emailBlacklist', 'smsBlacklist' => 'smsBlacklist', 'updateExistingContacts' => 'updateExistingContacts', 'emptyContactsAttributes' => 'emptyContactsAttributes' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'fileUrl' => 'setFileUrl', 'fileBody' => 'setFileBody', 'jsonBody' => 'setJsonBody', 'listIds' => 'setListIds', 'notifyUrl' => 'setNotifyUrl', 'newList' => 'setNewList', 'emailBlacklist' => 'setEmailBlacklist', 'smsBlacklist' => 'setSmsBlacklist', 'updateExistingContacts' => 'setUpdateExistingContacts', 'emptyContactsAttributes' => 'setEmptyContactsAttributes' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'fileUrl' => 'getFileUrl', 'fileBody' => 'getFileBody', 'jsonBody' => 'getJsonBody', 'listIds' => 'getListIds', 'notifyUrl' => 'getNotifyUrl', 'newList' => 'getNewList', 'emailBlacklist' => 'getEmailBlacklist', 'smsBlacklist' => 'getSmsBlacklist', 'updateExistingContacts' => 'getUpdateExistingContacts', 'emptyContactsAttributes' => 'getEmptyContactsAttributes' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['fileUrl'] = isset($data['fileUrl']) ? $data['fileUrl'] : null; $this->container['fileBody'] = isset($data['fileBody']) ? $data['fileBody'] : null; $this->container['jsonBody'] = isset($data['jsonBody']) ? $data['jsonBody'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['notifyUrl'] = isset($data['notifyUrl']) ? $data['notifyUrl'] : null; $this->container['newList'] = isset($data['newList']) ? $data['newList'] : null; $this->container['emailBlacklist'] = isset($data['emailBlacklist']) ? $data['emailBlacklist'] : false; $this->container['smsBlacklist'] = isset($data['smsBlacklist']) ? $data['smsBlacklist'] : false; $this->container['updateExistingContacts'] = isset($data['updateExistingContacts']) ? $data['updateExistingContacts'] : true; $this->container['emptyContactsAttributes'] = isset($data['emptyContactsAttributes']) ? $data['emptyContactsAttributes'] : false; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets fileUrl * * @return string */ public function getFileUrl() { return $this->container['fileUrl']; } /** * Sets fileUrl * * @param string $fileUrl Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json * * @return $this */ public function setFileUrl($fileUrl) { $this->container['fileUrl'] = $fileUrl; return $this; } /** * Gets fileBody * * @return string */ public function getFileBody() { return $this->container['fileBody']; } /** * Sets fileBody * * @param string $fileBody Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files. * * @return $this */ public function setFileBody($fileBody) { $this->container['fileBody'] = $fileBody; return $this; } /** * Gets jsonBody * * @return \Brevo\Client\Model\RequestContactImportJsonBody[] */ public function getJsonBody() { return $this->container['jsonBody']; } /** * Sets jsonBody * * @param \Brevo\Client\Model\RequestContactImportJsonBody[] $jsonBody **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. * * @return $this */ public function setJsonBody($jsonBody) { $this->container['jsonBody'] = $jsonBody; return $this; } /** * Gets listIds * * @return int[] */ public function getListIds() { return $this->container['listIds']; } /** * Sets listIds * * @param int[] $listIds Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7]. * * @return $this */ public function setListIds($listIds) { $this->container['listIds'] = $listIds; return $this; } /** * Gets notifyUrl * * @return string */ public function getNotifyUrl() { return $this->container['notifyUrl']; } /** * Sets notifyUrl * * @param string $notifyUrl URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 * * @return $this */ public function setNotifyUrl($notifyUrl) { $this->container['notifyUrl'] = $notifyUrl; return $this; } /** * Gets newList * * @return \Brevo\Client\Model\RequestContactImportNewList */ public function getNewList() { return $this->container['newList']; } /** * Sets newList * * @param \Brevo\Client\Model\RequestContactImportNewList $newList newList * * @return $this */ public function setNewList($newList) { $this->container['newList'] = $newList; return $this; } /** * Gets emailBlacklist * * @return bool */ public function getEmailBlacklist() { return $this->container['emailBlacklist']; } /** * Sets emailBlacklist * * @param bool $emailBlacklist To blacklist all the contacts for email * * @return $this */ public function setEmailBlacklist($emailBlacklist) { $this->container['emailBlacklist'] = $emailBlacklist; return $this; } /** * Gets smsBlacklist * * @return bool */ public function getSmsBlacklist() { return $this->container['smsBlacklist']; } /** * Sets smsBlacklist * * @param bool $smsBlacklist To blacklist all the contacts for sms * * @return $this */ public function setSmsBlacklist($smsBlacklist) { $this->container['smsBlacklist'] = $smsBlacklist; return $this; } /** * Gets updateExistingContacts * * @return bool */ public function getUpdateExistingContacts() { return $this->container['updateExistingContacts']; } /** * Sets updateExistingContacts * * @param bool $updateExistingContacts To facilitate the choice to update the existing contacts * * @return $this */ public function setUpdateExistingContacts($updateExistingContacts) { $this->container['updateExistingContacts'] = $updateExistingContacts; return $this; } /** * Gets emptyContactsAttributes * * @return bool */ public function getEmptyContactsAttributes() { return $this->container['emptyContactsAttributes']; } /** * Sets emptyContactsAttributes * * @param bool $emptyContactsAttributes To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) * * @return $this */ public function setEmptyContactsAttributes($emptyContactsAttributes) { $this->container['emptyContactsAttributes'] = $emptyContactsAttributes; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetEmailCampaign.php 0000644 00000101325 15021222673 0014116 0 ustar 00 <?php /** * GetEmailCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetEmailCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getEmailCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string', 'subject' => 'string', 'type' => 'string', 'status' => 'string', 'scheduledAt' => 'string', 'abTesting' => 'bool', 'subjectA' => 'string', 'subjectB' => 'string', 'splitRule' => 'int', 'winnerCriteria' => 'string', 'winnerDelay' => 'int', 'sendAtBestTime' => 'bool', 'testSent' => 'bool', 'header' => 'string', 'footer' => 'string', 'sender' => '\Brevo\Client\Model\GetExtendedCampaignOverviewSender', 'replyTo' => 'string', 'toField' => 'string', 'htmlContent' => 'string', 'shareLink' => 'string', 'tag' => 'string', 'createdAt' => 'string', 'modifiedAt' => 'string', 'inlineImageActivation' => 'bool', 'mirrorActive' => 'bool', 'recurring' => 'bool', 'sentDate' => 'string', 'returnBounce' => 'int', 'recipients' => 'object', 'statistics' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null, 'subject' => null, 'type' => null, 'status' => null, 'scheduledAt' => null, 'abTesting' => null, 'subjectA' => null, 'subjectB' => null, 'splitRule' => null, 'winnerCriteria' => null, 'winnerDelay' => null, 'sendAtBestTime' => null, 'testSent' => null, 'header' => null, 'footer' => null, 'sender' => null, 'replyTo' => 'email', 'toField' => null, 'htmlContent' => null, 'shareLink' => 'url', 'tag' => null, 'createdAt' => null, 'modifiedAt' => null, 'inlineImageActivation' => null, 'mirrorActive' => null, 'recurring' => null, 'sentDate' => null, 'returnBounce' => 'int64', 'recipients' => null, 'statistics' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name', 'subject' => 'subject', 'type' => 'type', 'status' => 'status', 'scheduledAt' => 'scheduledAt', 'abTesting' => 'abTesting', 'subjectA' => 'subjectA', 'subjectB' => 'subjectB', 'splitRule' => 'splitRule', 'winnerCriteria' => 'winnerCriteria', 'winnerDelay' => 'winnerDelay', 'sendAtBestTime' => 'sendAtBestTime', 'testSent' => 'testSent', 'header' => 'header', 'footer' => 'footer', 'sender' => 'sender', 'replyTo' => 'replyTo', 'toField' => 'toField', 'htmlContent' => 'htmlContent', 'shareLink' => 'shareLink', 'tag' => 'tag', 'createdAt' => 'createdAt', 'modifiedAt' => 'modifiedAt', 'inlineImageActivation' => 'inlineImageActivation', 'mirrorActive' => 'mirrorActive', 'recurring' => 'recurring', 'sentDate' => 'sentDate', 'returnBounce' => 'returnBounce', 'recipients' => 'recipients', 'statistics' => 'statistics' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName', 'subject' => 'setSubject', 'type' => 'setType', 'status' => 'setStatus', 'scheduledAt' => 'setScheduledAt', 'abTesting' => 'setAbTesting', 'subjectA' => 'setSubjectA', 'subjectB' => 'setSubjectB', 'splitRule' => 'setSplitRule', 'winnerCriteria' => 'setWinnerCriteria', 'winnerDelay' => 'setWinnerDelay', 'sendAtBestTime' => 'setSendAtBestTime', 'testSent' => 'setTestSent', 'header' => 'setHeader', 'footer' => 'setFooter', 'sender' => 'setSender', 'replyTo' => 'setReplyTo', 'toField' => 'setToField', 'htmlContent' => 'setHtmlContent', 'shareLink' => 'setShareLink', 'tag' => 'setTag', 'createdAt' => 'setCreatedAt', 'modifiedAt' => 'setModifiedAt', 'inlineImageActivation' => 'setInlineImageActivation', 'mirrorActive' => 'setMirrorActive', 'recurring' => 'setRecurring', 'sentDate' => 'setSentDate', 'returnBounce' => 'setReturnBounce', 'recipients' => 'setRecipients', 'statistics' => 'setStatistics' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName', 'subject' => 'getSubject', 'type' => 'getType', 'status' => 'getStatus', 'scheduledAt' => 'getScheduledAt', 'abTesting' => 'getAbTesting', 'subjectA' => 'getSubjectA', 'subjectB' => 'getSubjectB', 'splitRule' => 'getSplitRule', 'winnerCriteria' => 'getWinnerCriteria', 'winnerDelay' => 'getWinnerDelay', 'sendAtBestTime' => 'getSendAtBestTime', 'testSent' => 'getTestSent', 'header' => 'getHeader', 'footer' => 'getFooter', 'sender' => 'getSender', 'replyTo' => 'getReplyTo', 'toField' => 'getToField', 'htmlContent' => 'getHtmlContent', 'shareLink' => 'getShareLink', 'tag' => 'getTag', 'createdAt' => 'getCreatedAt', 'modifiedAt' => 'getModifiedAt', 'inlineImageActivation' => 'getInlineImageActivation', 'mirrorActive' => 'getMirrorActive', 'recurring' => 'getRecurring', 'sentDate' => 'getSentDate', 'returnBounce' => 'getReturnBounce', 'recipients' => 'getRecipients', 'statistics' => 'getStatistics' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_CLASSIC = 'classic'; const TYPE_TRIGGER = 'trigger'; const STATUS_DRAFT = 'draft'; const STATUS_SENT = 'sent'; const STATUS_ARCHIVE = 'archive'; const STATUS_QUEUED = 'queued'; const STATUS_SUSPENDED = 'suspended'; const STATUS_IN_PROCESS = 'in_process'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_CLASSIC, self::TYPE_TRIGGER, ]; } /** * Gets allowable values of the enum * * @return string[] */ public function getStatusAllowableValues() { return [ self::STATUS_DRAFT, self::STATUS_SENT, self::STATUS_ARCHIVE, self::STATUS_QUEUED, self::STATUS_SUSPENDED, self::STATUS_IN_PROCESS, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['subject'] = isset($data['subject']) ? $data['subject'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['status'] = isset($data['status']) ? $data['status'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['abTesting'] = isset($data['abTesting']) ? $data['abTesting'] : null; $this->container['subjectA'] = isset($data['subjectA']) ? $data['subjectA'] : null; $this->container['subjectB'] = isset($data['subjectB']) ? $data['subjectB'] : null; $this->container['splitRule'] = isset($data['splitRule']) ? $data['splitRule'] : null; $this->container['winnerCriteria'] = isset($data['winnerCriteria']) ? $data['winnerCriteria'] : null; $this->container['winnerDelay'] = isset($data['winnerDelay']) ? $data['winnerDelay'] : null; $this->container['sendAtBestTime'] = isset($data['sendAtBestTime']) ? $data['sendAtBestTime'] : null; $this->container['testSent'] = isset($data['testSent']) ? $data['testSent'] : null; $this->container['header'] = isset($data['header']) ? $data['header'] : null; $this->container['footer'] = isset($data['footer']) ? $data['footer'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['replyTo'] = isset($data['replyTo']) ? $data['replyTo'] : null; $this->container['toField'] = isset($data['toField']) ? $data['toField'] : null; $this->container['htmlContent'] = isset($data['htmlContent']) ? $data['htmlContent'] : null; $this->container['shareLink'] = isset($data['shareLink']) ? $data['shareLink'] : null; $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null; $this->container['inlineImageActivation'] = isset($data['inlineImageActivation']) ? $data['inlineImageActivation'] : null; $this->container['mirrorActive'] = isset($data['mirrorActive']) ? $data['mirrorActive'] : null; $this->container['recurring'] = isset($data['recurring']) ? $data['recurring'] : null; $this->container['sentDate'] = isset($data['sentDate']) ? $data['sentDate'] : null; $this->container['returnBounce'] = isset($data['returnBounce']) ? $data['returnBounce'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['statistics'] = isset($data['statistics']) ? $data['statistics'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['status'] === null) { $invalidProperties[] = "'status' can't be null"; } $allowedValues = $this->getStatusAllowableValues(); if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['testSent'] === null) { $invalidProperties[] = "'testSent' can't be null"; } if ($this->container['header'] === null) { $invalidProperties[] = "'header' can't be null"; } if ($this->container['footer'] === null) { $invalidProperties[] = "'footer' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ($this->container['replyTo'] === null) { $invalidProperties[] = "'replyTo' can't be null"; } if ($this->container['htmlContent'] === null) { $invalidProperties[] = "'htmlContent' can't be null"; } if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } if ($this->container['modifiedAt'] === null) { $invalidProperties[] = "'modifiedAt' can't be null"; } if ($this->container['recipients'] === null) { $invalidProperties[] = "'recipients' can't be null"; } if ($this->container['statistics'] === null) { $invalidProperties[] = "'statistics' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the campaign * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets subject * * @return string */ public function getSubject() { return $this->container['subject']; } /** * Sets subject * * @param string $subject Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` * * @return $this */ public function setSubject($subject) { $this->container['subject'] = $subject; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type Type of campaign * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets status * * @return string */ public function getStatus() { return $this->container['status']; } /** * Sets status * * @param string $status Status of the campaign * * @return $this */ public function setStatus($status) { $allowedValues = $this->getStatusAllowableValues(); if (!in_array($status, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'status', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['status'] = $status; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets abTesting * * @return bool */ public function getAbTesting() { return $this->container['abTesting']; } /** * Sets abTesting * * @param bool $abTesting Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. * * @return $this */ public function setAbTesting($abTesting) { $this->container['abTesting'] = $abTesting; return $this; } /** * Gets subjectA * * @return string */ public function getSubjectA() { return $this->container['subjectA']; } /** * Sets subjectA * * @param string $subjectA Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectA($subjectA) { $this->container['subjectA'] = $subjectA; return $this; } /** * Gets subjectB * * @return string */ public function getSubjectB() { return $this->container['subjectB']; } /** * Sets subjectB * * @param string $subjectB Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSubjectB($subjectB) { $this->container['subjectB'] = $subjectB; return $this; } /** * Gets splitRule * * @return int */ public function getSplitRule() { return $this->container['splitRule']; } /** * Sets splitRule * * @param int $splitRule The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setSplitRule($splitRule) { $this->container['splitRule'] = $splitRule; return $this; } /** * Gets winnerCriteria * * @return string */ public function getWinnerCriteria() { return $this->container['winnerCriteria']; } /** * Sets winnerCriteria * * @param string $winnerCriteria Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerCriteria($winnerCriteria) { $this->container['winnerCriteria'] = $winnerCriteria; return $this; } /** * Gets winnerDelay * * @return int */ public function getWinnerDelay() { return $this->container['winnerDelay']; } /** * Sets winnerDelay * * @param int $winnerDelay The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` * * @return $this */ public function setWinnerDelay($winnerDelay) { $this->container['winnerDelay'] = $winnerDelay; return $this; } /** * Gets sendAtBestTime * * @return bool */ public function getSendAtBestTime() { return $this->container['sendAtBestTime']; } /** * Sets sendAtBestTime * * @param bool $sendAtBestTime It is true if you have chosen to send your campaign at best time, otherwise it is false * * @return $this */ public function setSendAtBestTime($sendAtBestTime) { $this->container['sendAtBestTime'] = $sendAtBestTime; return $this; } /** * Gets testSent * * @return bool */ public function getTestSent() { return $this->container['testSent']; } /** * Sets testSent * * @param bool $testSent Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) * * @return $this */ public function setTestSent($testSent) { $this->container['testSent'] = $testSent; return $this; } /** * Gets header * * @return string */ public function getHeader() { return $this->container['header']; } /** * Sets header * * @param string $header Header of the campaign * * @return $this */ public function setHeader($header) { $this->container['header'] = $header; return $this; } /** * Gets footer * * @return string */ public function getFooter() { return $this->container['footer']; } /** * Sets footer * * @param string $footer Footer of the campaign * * @return $this */ public function setFooter($footer) { $this->container['footer'] = $footer; return $this; } /** * Gets sender * * @return \Brevo\Client\Model\GetExtendedCampaignOverviewSender */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param \Brevo\Client\Model\GetExtendedCampaignOverviewSender $sender sender * * @return $this */ public function setSender($sender) { $this->container['sender'] = $sender; return $this; } /** * Gets replyTo * * @return string */ public function getReplyTo() { return $this->container['replyTo']; } /** * Sets replyTo * * @param string $replyTo Email defined as the \"Reply to\" of the campaign * * @return $this */ public function setReplyTo($replyTo) { $this->container['replyTo'] = $replyTo; return $this; } /** * Gets toField * * @return string */ public function getToField() { return $this->container['toField']; } /** * Sets toField * * @param string $toField Customisation of the \"to\" field of the campaign * * @return $this */ public function setToField($toField) { $this->container['toField'] = $toField; return $this; } /** * Gets htmlContent * * @return string */ public function getHtmlContent() { return $this->container['htmlContent']; } /** * Sets htmlContent * * @param string $htmlContent HTML content of the campaign * * @return $this */ public function setHtmlContent($htmlContent) { $this->container['htmlContent'] = $htmlContent; return $this; } /** * Gets shareLink * * @return string */ public function getShareLink() { return $this->container['shareLink']; } /** * Sets shareLink * * @param string $shareLink Link to share the campaign on social medias * * @return $this */ public function setShareLink($shareLink) { $this->container['shareLink'] = $shareLink; return $this; } /** * Gets tag * * @return string */ public function getTag() { return $this->container['tag']; } /** * Sets tag * * @param string $tag Tag of the campaign * * @return $this */ public function setTag($tag) { $this->container['tag'] = $tag; return $this; } /** * Gets createdAt * * @return string */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param string $createdAt Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setCreatedAt($createdAt) { $this->container['createdAt'] = $createdAt; return $this; } /** * Gets modifiedAt * * @return string */ public function getModifiedAt() { return $this->container['modifiedAt']; } /** * Sets modifiedAt * * @param string $modifiedAt UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) * * @return $this */ public function setModifiedAt($modifiedAt) { $this->container['modifiedAt'] = $modifiedAt; return $this; } /** * Gets inlineImageActivation * * @return bool */ public function getInlineImageActivation() { return $this->container['inlineImageActivation']; } /** * Sets inlineImageActivation * * @param bool $inlineImageActivation Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. * * @return $this */ public function setInlineImageActivation($inlineImageActivation) { $this->container['inlineImageActivation'] = $inlineImageActivation; return $this; } /** * Gets mirrorActive * * @return bool */ public function getMirrorActive() { return $this->container['mirrorActive']; } /** * Sets mirrorActive * * @param bool $mirrorActive Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign * * @return $this */ public function setMirrorActive($mirrorActive) { $this->container['mirrorActive'] = $mirrorActive; return $this; } /** * Gets recurring * * @return bool */ public function getRecurring() { return $this->container['recurring']; } /** * Sets recurring * * @param bool $recurring FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times * * @return $this */ public function setRecurring($recurring) { $this->container['recurring'] = $recurring; return $this; } /** * Gets sentDate * * @return string */ public function getSentDate() { return $this->container['sentDate']; } /** * Sets sentDate * * @param string $sentDate Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' * * @return $this */ public function setSentDate($sentDate) { $this->container['sentDate'] = $sentDate; return $this; } /** * Gets returnBounce * * @return int */ public function getReturnBounce() { return $this->container['returnBounce']; } /** * Sets returnBounce * * @param int $returnBounce Total number of non-delivered campaigns for a particular campaign id. * * @return $this */ public function setReturnBounce($returnBounce) { $this->container['returnBounce'] = $returnBounce; return $this; } /** * Gets recipients * * @return object */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param object $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets statistics * * @return object */ public function getStatistics() { return $this->container['statistics']; } /** * Sets statistics * * @param object $statistics statistics * * @return $this */ public function setStatistics($statistics) { $this->container['statistics'] = $statistics; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateEmailCampaignSender.php 0000644 00000021222 15021222673 0015740 0 ustar 00 <?php /** * CreateEmailCampaignSender * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateEmailCampaignSender Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaignSender implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createEmailCampaign_sender'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'email' => 'string', 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'email' => 'email', 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'email' => 'email', 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'email' => 'setEmail', 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'email' => 'getEmail', 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Sender Name * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Sender email * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateExternalFeed.php 0000644 00000034647 15021222673 0014475 0 ustar 00 <?php /** * CreateExternalFeed * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateExternalFeed Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateExternalFeed implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createExternalFeed'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'url' => 'string', 'authType' => 'string', 'username' => 'string', 'password' => 'string', 'token' => 'string', 'headers' => '\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]', 'maxRetries' => 'int', 'cache' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'url' => 'url', 'authType' => null, 'username' => null, 'password' => null, 'token' => null, 'headers' => null, 'maxRetries' => null, 'cache' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'url' => 'url', 'authType' => 'authType', 'username' => 'username', 'password' => 'password', 'token' => 'token', 'headers' => 'headers', 'maxRetries' => 'maxRetries', 'cache' => 'cache' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'url' => 'setUrl', 'authType' => 'setAuthType', 'username' => 'setUsername', 'password' => 'setPassword', 'token' => 'setToken', 'headers' => 'setHeaders', 'maxRetries' => 'setMaxRetries', 'cache' => 'setCache' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'url' => 'getUrl', 'authType' => 'getAuthType', 'username' => 'getUsername', 'password' => 'getPassword', 'token' => 'getToken', 'headers' => 'getHeaders', 'maxRetries' => 'getMaxRetries', 'cache' => 'getCache' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const AUTH_TYPE_BASIC = 'basic'; const AUTH_TYPE_TOKEN = 'token'; const AUTH_TYPE_NO_AUTH = 'noAuth'; /** * Gets allowable values of the enum * * @return string[] */ public function getAuthTypeAllowableValues() { return [ self::AUTH_TYPE_BASIC, self::AUTH_TYPE_TOKEN, self::AUTH_TYPE_NO_AUTH, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['url'] = isset($data['url']) ? $data['url'] : null; $this->container['authType'] = isset($data['authType']) ? $data['authType'] : 'noAuth'; $this->container['username'] = isset($data['username']) ? $data['username'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['token'] = isset($data['token']) ? $data['token'] : null; $this->container['headers'] = isset($data['headers']) ? $data['headers'] : null; $this->container['maxRetries'] = isset($data['maxRetries']) ? $data['maxRetries'] : null; $this->container['cache'] = isset($data['cache']) ? $data['cache'] : false; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['url'] === null) { $invalidProperties[] = "'url' can't be null"; } $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($this->container['authType']) && !in_array($this->container['authType'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ); } if (!is_null($this->container['maxRetries']) && ($this->container['maxRetries'] > 5)) { $invalidProperties[] = "invalid value for 'maxRetries', must be smaller than or equal to 5."; } if (!is_null($this->container['maxRetries']) && ($this->container['maxRetries'] < 0)) { $invalidProperties[] = "invalid value for 'maxRetries', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the feed * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets url * * @return string */ public function getUrl() { return $this->container['url']; } /** * Sets url * * @param string $url URL of the feed * * @return $this */ public function setUrl($url) { $this->container['url'] = $url; return $this; } /** * Gets authType * * @return string */ public function getAuthType() { return $this->container['authType']; } /** * Sets authType * * @param string $authType Auth type of the feed: * `basic` * `token` * `noAuth` * * @return $this */ public function setAuthType($authType) { $allowedValues = $this->getAuthTypeAllowableValues(); if (!is_null($authType) && !in_array($authType, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'authType', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['authType'] = $authType; return $this; } /** * Gets username * * @return string */ public function getUsername() { return $this->container['username']; } /** * Sets username * * @param string $username Username for authType `basic` * * @return $this */ public function setUsername($username) { $this->container['username'] = $username; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password Password for authType `basic` * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets token * * @return string */ public function getToken() { return $this->container['token']; } /** * Sets token * * @param string $token Token for authType `token` * * @return $this */ public function setToken($token) { $this->container['token'] = $token; return $this; } /** * Gets headers * * @return \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] */ public function getHeaders() { return $this->container['headers']; } /** * Sets headers * * @param \Brevo\Client\Model\GetExternalFeedByUUIDHeaders[] $headers Custom headers for the feed * * @return $this */ public function setHeaders($headers) { $this->container['headers'] = $headers; return $this; } /** * Gets maxRetries * * @return int */ public function getMaxRetries() { return $this->container['maxRetries']; } /** * Sets maxRetries * * @param int $maxRetries Maximum number of retries on the feed url * * @return $this */ public function setMaxRetries($maxRetries) { if (!is_null($maxRetries) && ($maxRetries > 5)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling CreateExternalFeed., must be smaller than or equal to 5.'); } if (!is_null($maxRetries) && ($maxRetries < 0)) { throw new \InvalidArgumentException('invalid value for $maxRetries when calling CreateExternalFeed., must be bigger than or equal to 0.'); } $this->container['maxRetries'] = $maxRetries; return $this; } /** * Gets cache * * @return bool */ public function getCache() { return $this->container['cache']; } /** * Sets cache * * @param bool $cache Toggle caching of feed url response * * @return $this */ public function setCache($cache) { $this->container['cache'] = $cache; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSmsCampaign.php 0000644 00000033743 15021222673 0014325 0 ustar 00 <?php /** * CreateSmsCampaign * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSmsCampaign Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmsCampaign implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSmsCampaign'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'sender' => 'string', 'content' => 'string', 'recipients' => '\Brevo\Client\Model\CreateSmsCampaignRecipients', 'scheduledAt' => 'string', 'unicodeEnabled' => 'bool', 'organisationPrefix' => 'string', 'unsubscribeInstruction' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'sender' => null, 'content' => null, 'recipients' => null, 'scheduledAt' => null, 'unicodeEnabled' => null, 'organisationPrefix' => null, 'unsubscribeInstruction' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'sender' => 'sender', 'content' => 'content', 'recipients' => 'recipients', 'scheduledAt' => 'scheduledAt', 'unicodeEnabled' => 'unicodeEnabled', 'organisationPrefix' => 'organisationPrefix', 'unsubscribeInstruction' => 'unsubscribeInstruction' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'sender' => 'setSender', 'content' => 'setContent', 'recipients' => 'setRecipients', 'scheduledAt' => 'setScheduledAt', 'unicodeEnabled' => 'setUnicodeEnabled', 'organisationPrefix' => 'setOrganisationPrefix', 'unsubscribeInstruction' => 'setUnsubscribeInstruction' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'sender' => 'getSender', 'content' => 'getContent', 'recipients' => 'getRecipients', 'scheduledAt' => 'getScheduledAt', 'unicodeEnabled' => 'getUnicodeEnabled', 'organisationPrefix' => 'getOrganisationPrefix', 'unsubscribeInstruction' => 'getUnsubscribeInstruction' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['sender'] = isset($data['sender']) ? $data['sender'] : null; $this->container['content'] = isset($data['content']) ? $data['content'] : null; $this->container['recipients'] = isset($data['recipients']) ? $data['recipients'] : null; $this->container['scheduledAt'] = isset($data['scheduledAt']) ? $data['scheduledAt'] : null; $this->container['unicodeEnabled'] = isset($data['unicodeEnabled']) ? $data['unicodeEnabled'] : false; $this->container['organisationPrefix'] = isset($data['organisationPrefix']) ? $data['organisationPrefix'] : null; $this->container['unsubscribeInstruction'] = isset($data['unsubscribeInstruction']) ? $data['unsubscribeInstruction'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['sender'] === null) { $invalidProperties[] = "'sender' can't be null"; } if ((mb_strlen($this->container['sender']) > 15)) { $invalidProperties[] = "invalid value for 'sender', the character length must be smaller than or equal to 15."; } if ($this->container['content'] === null) { $invalidProperties[] = "'content' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the campaign * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets sender * * @return string */ public function getSender() { return $this->container['sender']; } /** * Sets sender * * @param string $sender Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** * * @return $this */ public function setSender($sender) { if ((mb_strlen($sender) > 15)) { throw new \InvalidArgumentException('invalid length for $sender when calling CreateSmsCampaign., must be smaller than or equal to 15.'); } $this->container['sender'] = $sender; return $this; } /** * Gets content * * @return string */ public function getContent() { return $this->container['content']; } /** * Sets content * * @param string $content Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS * * @return $this */ public function setContent($content) { $this->container['content'] = $content; return $this; } /** * Gets recipients * * @return \Brevo\Client\Model\CreateSmsCampaignRecipients */ public function getRecipients() { return $this->container['recipients']; } /** * Sets recipients * * @param \Brevo\Client\Model\CreateSmsCampaignRecipients $recipients recipients * * @return $this */ public function setRecipients($recipients) { $this->container['recipients'] = $recipients; return $this; } /** * Gets scheduledAt * * @return string */ public function getScheduledAt() { return $this->container['scheduledAt']; } /** * Sets scheduledAt * * @param string $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * * @return $this */ public function setScheduledAt($scheduledAt) { $this->container['scheduledAt'] = $scheduledAt; return $this; } /** * Gets unicodeEnabled * * @return bool */ public function getUnicodeEnabled() { return $this->container['unicodeEnabled']; } /** * Sets unicodeEnabled * * @param bool $unicodeEnabled Format of the message. It indicates whether the content should be treated as unicode or not. * * @return $this */ public function setUnicodeEnabled($unicodeEnabled) { $this->container['unicodeEnabled'] = $unicodeEnabled; return $this; } /** * Gets organisationPrefix * * @return string */ public function getOrganisationPrefix() { return $this->container['organisationPrefix']; } /** * Sets organisationPrefix * * @param string $organisationPrefix A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** * * @return $this */ public function setOrganisationPrefix($organisationPrefix) { $this->container['organisationPrefix'] = $organisationPrefix; return $this; } /** * Gets unsubscribeInstruction * * @return string */ public function getUnsubscribeInstruction() { return $this->container['unsubscribeInstruction']; } /** * Sets unsubscribeInstruction * * @param string $unsubscribeInstruction Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** * * @return $this */ public function setUnsubscribeInstruction($unsubscribeInstruction) { $this->container['unsubscribeInstruction'] = $unsubscribeInstruction; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/ConversationsMessage.php 0000644 00000035222 15021222673 0015133 0 ustar 00 <?php /** * ConversationsMessage * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * ConversationsMessage Class Doc Comment * * @category Class * @description a Conversations message * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessage implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'ConversationsMessage'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string', 'type' => 'string', 'text' => 'string', 'visitorId' => 'string', 'agentId' => 'string', 'agentName' => 'string', 'createdAt' => 'int', 'isPushed' => 'bool', 'receivedFrom' => 'string', 'file' => '\Brevo\Client\Model\ConversationsMessageFile' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null, 'type' => null, 'text' => null, 'visitorId' => null, 'agentId' => null, 'agentName' => null, 'createdAt' => 'int64', 'isPushed' => null, 'receivedFrom' => null, 'file' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'type' => 'type', 'text' => 'text', 'visitorId' => 'visitorId', 'agentId' => 'agentId', 'agentName' => 'agentName', 'createdAt' => 'createdAt', 'isPushed' => 'isPushed', 'receivedFrom' => 'receivedFrom', 'file' => 'file' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'type' => 'setType', 'text' => 'setText', 'visitorId' => 'setVisitorId', 'agentId' => 'setAgentId', 'agentName' => 'setAgentName', 'createdAt' => 'setCreatedAt', 'isPushed' => 'setIsPushed', 'receivedFrom' => 'setReceivedFrom', 'file' => 'setFile' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'type' => 'getType', 'text' => 'getText', 'visitorId' => 'getVisitorId', 'agentId' => 'getAgentId', 'agentName' => 'getAgentName', 'createdAt' => 'getCreatedAt', 'isPushed' => 'getIsPushed', 'receivedFrom' => 'getReceivedFrom', 'file' => 'getFile' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const TYPE_AGENT = 'agent'; const TYPE_VISITOR = 'visitor'; /** * Gets allowable values of the enum * * @return string[] */ public function getTypeAllowableValues() { return [ self::TYPE_AGENT, self::TYPE_VISITOR, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['type'] = isset($data['type']) ? $data['type'] : null; $this->container['text'] = isset($data['text']) ? $data['text'] : null; $this->container['visitorId'] = isset($data['visitorId']) ? $data['visitorId'] : null; $this->container['agentId'] = isset($data['agentId']) ? $data['agentId'] : null; $this->container['agentName'] = isset($data['agentName']) ? $data['agentName'] : null; $this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null; $this->container['isPushed'] = isset($data['isPushed']) ? $data['isPushed'] : null; $this->container['receivedFrom'] = isset($data['receivedFrom']) ? $data['receivedFrom'] : null; $this->container['file'] = isset($data['file']) ? $data['file'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; $allowedValues = $this->getTypeAllowableValues(); if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ); } if (!is_null($this->container['createdAt']) && ($this->container['createdAt'] < 0)) { $invalidProperties[] = "invalid value for 'createdAt', must be bigger than or equal to 0."; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Message ID. It can be used for further manipulations with the message. * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets type * * @return string */ public function getType() { return $this->container['type']; } /** * Sets type * * @param string $type `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. * * @return $this */ public function setType($type) { $allowedValues = $this->getTypeAllowableValues(); if (!is_null($type) && !in_array($type, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'type', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['type'] = $type; return $this; } /** * Gets text * * @return string */ public function getText() { return $this->container['text']; } /** * Sets text * * @param string $text Message text or name of the attached file * * @return $this */ public function setText($text) { $this->container['text'] = $text; return $this; } /** * Gets visitorId * * @return string */ public function getVisitorId() { return $this->container['visitorId']; } /** * Sets visitorId * * @param string $visitorId visitor’s ID * * @return $this */ public function setVisitorId($visitorId) { $this->container['visitorId'] = $visitorId; return $this; } /** * Gets agentId * * @return string */ public function getAgentId() { return $this->container['agentId']; } /** * Sets agentId * * @param string $agentId ID of the agent on whose behalf the message was sent (only in messages sent by an agent). * * @return $this */ public function setAgentId($agentId) { $this->container['agentId'] = $agentId; return $this; } /** * Gets agentName * * @return string */ public function getAgentName() { return $this->container['agentName']; } /** * Sets agentName * * @param string $agentName Agent’s name as displayed to the visitor. Only in the messages sent by an agent. * * @return $this */ public function setAgentName($agentName) { $this->container['agentName'] = $agentName; return $this; } /** * Gets createdAt * * @return int */ public function getCreatedAt() { return $this->container['createdAt']; } /** * Sets createdAt * * @param int $createdAt Timestamp in milliseconds. * * @return $this */ public function setCreatedAt($createdAt) { if (!is_null($createdAt) && ($createdAt < 0)) { throw new \InvalidArgumentException('invalid value for $createdAt when calling ConversationsMessage., must be bigger than or equal to 0.'); } $this->container['createdAt'] = $createdAt; return $this; } /** * Gets isPushed * * @return bool */ public function getIsPushed() { return $this->container['isPushed']; } /** * Sets isPushed * * @param bool $isPushed `true` for pushed messages * * @return $this */ public function setIsPushed($isPushed) { $this->container['isPushed'] = $isPushed; return $this; } /** * Gets receivedFrom * * @return string */ public function getReceivedFrom() { return $this->container['receivedFrom']; } /** * Sets receivedFrom * * @param string $receivedFrom In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. * * @return $this */ public function setReceivedFrom($receivedFrom) { $this->container['receivedFrom'] = $receivedFrom; return $this; } /** * Gets file * * @return \Brevo\Client\Model\ConversationsMessageFile */ public function getFile() { return $this->container['file']; } /** * Sets file * * @param \Brevo\Client\Model\ConversationsMessageFile $file file * * @return $this */ public function setFile($file) { $this->container['file'] = $file; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSenderModel.php 0000644 00000021000 15021222673 0014303 0 ustar 00 <?php /** * CreateSenderModel * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSenderModel Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSenderModel implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSenderModel'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'spfError' => 'bool', 'dkimError' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'spfError' => null, 'dkimError' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'spfError' => 'spfError', 'dkimError' => 'dkimError' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'spfError' => 'setSpfError', 'dkimError' => 'setDkimError' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'spfError' => 'getSpfError', 'dkimError' => 'getDkimError' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['spfError'] = isset($data['spfError']) ? $data['spfError'] : null; $this->container['dkimError'] = isset($data['dkimError']) ? $data['dkimError'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the Sender created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets spfError * * @return bool */ public function getSpfError() { return $this->container['spfError']; } /** * Sets spfError * * @param bool $spfError Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) * * @return $this */ public function setSpfError($spfError) { $this->container['spfError'] = $spfError; return $this; } /** * Gets dkimError * * @return bool */ public function getDkimError() { return $this->container['dkimError']; } /** * Sets dkimError * * @param bool $dkimError Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) * * @return $this */ public function setDkimError($dkimError) { $this->container['dkimError'] = $dkimError; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateWhatsAppTemplate.php 0000644 00000030374 15021222673 0015343 0 ustar 00 <?php /** * CreateWhatsAppTemplate * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateWhatsAppTemplate Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppTemplate implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createWhatsAppTemplate'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'name' => 'string', 'language' => 'string', 'category' => 'string', 'mediaUrl' => 'string', 'bodyText' => 'string', 'headerText' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'name' => null, 'language' => null, 'category' => null, 'mediaUrl' => null, 'bodyText' => null, 'headerText' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'name' => 'name', 'language' => 'language', 'category' => 'category', 'mediaUrl' => 'mediaUrl', 'bodyText' => 'bodyText', 'headerText' => 'headerText' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'name' => 'setName', 'language' => 'setLanguage', 'category' => 'setCategory', 'mediaUrl' => 'setMediaUrl', 'bodyText' => 'setBodyText', 'headerText' => 'setHeaderText' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'name' => 'getName', 'language' => 'getLanguage', 'category' => 'getCategory', 'mediaUrl' => 'getMediaUrl', 'bodyText' => 'getBodyText', 'headerText' => 'getHeaderText' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const CATEGORY_MARKETING = 'MARKETING'; const CATEGORY_TRANSACTIONAL = 'TRANSACTIONAL'; /** * Gets allowable values of the enum * * @return string[] */ public function getCategoryAllowableValues() { return [ self::CATEGORY_MARKETING, self::CATEGORY_TRANSACTIONAL, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['name'] = isset($data['name']) ? $data['name'] : null; $this->container['language'] = isset($data['language']) ? $data['language'] : null; $this->container['category'] = isset($data['category']) ? $data['category'] : null; $this->container['mediaUrl'] = isset($data['mediaUrl']) ? $data['mediaUrl'] : null; $this->container['bodyText'] = isset($data['bodyText']) ? $data['bodyText'] : null; $this->container['headerText'] = isset($data['headerText']) ? $data['headerText'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['name'] === null) { $invalidProperties[] = "'name' can't be null"; } if ($this->container['language'] === null) { $invalidProperties[] = "'language' can't be null"; } if ($this->container['category'] === null) { $invalidProperties[] = "'category' can't be null"; } $allowedValues = $this->getCategoryAllowableValues(); if (!is_null($this->container['category']) && !in_array($this->container['category'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'category', must be one of '%s'", implode("', '", $allowedValues) ); } if ($this->container['bodyText'] === null) { $invalidProperties[] = "'bodyText' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the template * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language Language of the template. For Example : **en** for English * * @return $this */ public function setLanguage($language) { $this->container['language'] = $language; return $this; } /** * Gets category * * @return string */ public function getCategory() { return $this->container['category']; } /** * Sets category * * @param string $category Category of the template * * @return $this */ public function setCategory($category) { $allowedValues = $this->getCategoryAllowableValues(); if (!in_array($category, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'category', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['category'] = $category; return $this; } /** * Gets mediaUrl * * @return string */ public function getMediaUrl() { return $this->container['mediaUrl']; } /** * Sets mediaUrl * * @param string $mediaUrl Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty.** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf * * @return $this */ public function setMediaUrl($mediaUrl) { $this->container['mediaUrl'] = $mediaUrl; return $this; } /** * Gets bodyText * * @return string */ public function getBodyText() { return $this->container['bodyText']; } /** * Sets bodyText * * @param string $bodyText Body of the template. **Maximum allowed characters are 1024** * * @return $this */ public function setBodyText($bodyText) { $this->container['bodyText'] = $bodyText; return $this; } /** * Gets headerText * * @return string */ public function getHeaderText() { return $this->container['headerText']; } /** * Sets headerText * * @param string $headerText Text content of the header in the template. **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty** * * @return $this */ public function setHeaderText($headerText) { $this->container['headerText'] = $headerText; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/InlineResponse2011.php 0000644 00000016057 15021222673 0014237 0 ustar 00 <?php /** * InlineResponse2011 * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * InlineResponse2011 Class Doc Comment * * @category Class * @description Task Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2011 implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'inline_response_201_1'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return string */ public function getId() { return $this->container['id']; } /** * Sets id * * @param string $id Unique task id * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetInvitedUsersListFeatureAccess.php 0000644 00000021015 15021222673 0017342 0 ustar 00 <?php /** * GetInvitedUsersListFeatureAccess * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetInvitedUsersListFeatureAccess Class Doc Comment * * @category Class * @description Feature accessiblity given to the user. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersListFeatureAccess implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getInvitedUsersList_feature_access'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'marketing' => 'object', 'conversations' => 'object', 'crm' => 'object' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'marketing' => 'string', 'conversations' => 'string', 'crm' => 'string' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'marketing' => 'marketing', 'conversations' => 'conversations', 'crm' => 'crm' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'marketing' => 'setMarketing', 'conversations' => 'setConversations', 'crm' => 'setCrm' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'marketing' => 'getMarketing', 'conversations' => 'getConversations', 'crm' => 'getCrm' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['marketing'] = isset($data['marketing']) ? $data['marketing'] : null; $this->container['conversations'] = isset($data['conversations']) ? $data['conversations'] : null; $this->container['crm'] = isset($data['crm']) ? $data['crm'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets marketing * * @return object */ public function getMarketing() { return $this->container['marketing']; } /** * Sets marketing * * @param object $marketing Marketing features accessiblity. * * @return $this */ public function setMarketing($marketing) { $this->container['marketing'] = $marketing; return $this; } /** * Gets conversations * * @return object */ public function getConversations() { return $this->container['conversations']; } /** * Sets conversations * * @param object $conversations Conversations features accessiblity. * * @return $this */ public function setConversations($conversations) { $this->container['conversations'] = $conversations; return $this; } /** * Gets crm * * @return object */ public function getCrm() { return $this->container['crm']; } /** * Sets crm * * @param object $crm CRM features accessiblity. * * @return $this */ public function setCrm($crm) { $this->container['crm'] = $crm; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/UpdateChild.php 0000644 00000023440 15021222673 0013156 0 ustar 00 <?php /** * UpdateChild * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * UpdateChild Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChild implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'updateChild'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'firstName' => 'string', 'lastName' => 'string', 'companyName' => 'string', 'password' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'firstName' => null, 'lastName' => null, 'companyName' => null, 'password' => 'password' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'firstName' => 'firstName', 'lastName' => 'lastName', 'companyName' => 'companyName', 'password' => 'password' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'firstName' => 'setFirstName', 'lastName' => 'setLastName', 'companyName' => 'setCompanyName', 'password' => 'setPassword' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'firstName' => 'getFirstName', 'lastName' => 'getLastName', 'companyName' => 'getCompanyName', 'password' => 'getPassword' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['firstName'] = isset($data['firstName']) ? $data['firstName'] : null; $this->container['lastName'] = isset($data['lastName']) ? $data['lastName'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email New Email address to update the child account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets firstName * * @return string */ public function getFirstName() { return $this->container['firstName']; } /** * Sets firstName * * @param string $firstName New First name to use to update the child account * * @return $this */ public function setFirstName($firstName) { $this->container['firstName'] = $firstName; return $this; } /** * Gets lastName * * @return string */ public function getLastName() { return $this->container['lastName']; } /** * Sets lastName * * @param string $lastName New Last name to use to update the child account * * @return $this */ public function setLastName($lastName) { $this->container['lastName'] = $lastName; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName New Company name to use to update the child account * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password New password for the child account to login * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateSubAccountResponse.php 0000644 00000016060 15021222673 0015701 0 ustar 00 <?php /** * CreateSubAccountResponse * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateSubAccountResponse Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSubAccountResponse implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createSubAccountResponse'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id ID of the sub-account created * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/AbTestVersionStats.php 0000644 00000020033 15021222673 0014532 0 ustar 00 <?php /** * AbTestVersionStats * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * AbTestVersionStats Class Doc Comment * * @category Class * @description Percentage of a particular event for both versions * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionStats implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'abTestVersionStats'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'versionA' => 'string', 'versionB' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'versionA' => null, 'versionB' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'versionA' => 'Version A', 'versionB' => 'Version B' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'versionA' => 'setVersionA', 'versionB' => 'setVersionB' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'versionA' => 'getVersionA', 'versionB' => 'getVersionB' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['versionA'] = isset($data['versionA']) ? $data['versionA'] : null; $this->container['versionB'] = isset($data['versionB']) ? $data['versionB'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['versionA'] === null) { $invalidProperties[] = "'versionA' can't be null"; } if ($this->container['versionB'] === null) { $invalidProperties[] = "'versionB' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets versionA * * @return string */ public function getVersionA() { return $this->container['versionA']; } /** * Sets versionA * * @param string $versionA percentage of an event for version A * * @return $this */ public function setVersionA($versionA) { $this->container['versionA'] = $versionA; return $this; } /** * Gets versionB * * @return string */ public function getVersionB() { return $this->container['versionB']; } /** * Sets versionB * * @param string $versionB percentage of an event for version B * * @return $this */ public function setVersionB($versionB) { $this->container['versionB'] = $versionB; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateApiKeyRequest.php 0000644 00000017157 15021222673 0014657 0 ustar 00 <?php /** * CreateApiKeyRequest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateApiKeyRequest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateApiKeyRequest implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createApiKeyRequest'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'id' => 'int', 'name' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'id' => 'int64', 'name' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'id' => 'id', 'name' => 'name' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'id' => 'setId', 'name' => 'setName' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'id' => 'getId', 'name' => 'getName' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['id'] = isset($data['id']) ? $data['id'] : null; $this->container['name'] = isset($data['name']) ? $data['name'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets id * * @return int */ public function getId() { return $this->container['id']; } /** * Sets id * * @param int $id Id of the sub-account organization * * @return $this */ public function setId($id) { $this->container['id'] = $id; return $this; } /** * Gets name * * @return string */ public function getName() { return $this->container['name']; } /** * Sets name * * @param string $name Name of the API key * * @return $this */ public function setName($name) { $this->container['name'] = $name; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.php 0000644 00000017703 15021222673 0027146 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getExtendedContactDetails_statistics_unsubscriptions_adminUnsubscription'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'eventTime' => 'string', 'ip' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'eventTime' => null, 'ip' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'eventTime' => 'eventTime', 'ip' => 'ip' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'eventTime' => 'setEventTime', 'ip' => 'setIp' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'eventTime' => 'getEventTime', 'ip' => 'getIp' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['eventTime'] = isset($data['eventTime']) ? $data['eventTime'] : null; $this->container['ip'] = isset($data['ip']) ? $data['ip'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['eventTime'] === null) { $invalidProperties[] = "'eventTime' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets eventTime * * @return string */ public function getEventTime() { return $this->container['eventTime']; } /** * Sets eventTime * * @param string $eventTime UTC date-time of the event * * @return $this */ public function setEventTime($eventTime) { $this->container['eventTime'] = $eventTime; return $this; } /** * Gets ip * * @return string */ public function getIp() { return $this->container['ip']; } /** * Sets ip * * @param string $ip IP from which the user has been unsubscribed * * @return $this */ public function setIp($ip) { $this->container['ip'] = $ip; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/FileDownloadableLink.php 0000644 00000016245 15021222673 0015006 0 ustar 00 <?php /** * FileDownloadableLink * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * FileDownloadableLink Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileDownloadableLink implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'FileDownloadableLink'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'fileUrl' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'fileUrl' => 'url' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'fileUrl' => 'fileUrl' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'fileUrl' => 'setFileUrl' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'fileUrl' => 'getFileUrl' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['fileUrl'] = isset($data['fileUrl']) ? $data['fileUrl'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['fileUrl'] === null) { $invalidProperties[] = "'fileUrl' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets fileUrl * * @return string */ public function getFileUrl() { return $this->container['fileUrl']; } /** * Sets fileUrl * * @param string $fileUrl A unique link to download the requested file. * * @return $this */ public function setFileUrl($fileUrl) { $this->container['fileUrl'] = $fileUrl; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/GetLists.php 0000644 00000017103 15021222673 0012525 0 ustar 00 <?php /** * GetLists * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * GetLists Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetLists implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'getLists'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'lists' => 'object[]', 'count' => 'int' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'lists' => null, 'count' => 'int64' ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'lists' => 'lists', 'count' => 'count' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'lists' => 'setLists', 'count' => 'setCount' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'lists' => 'getLists', 'count' => 'getCount' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['lists'] = isset($data['lists']) ? $data['lists'] : null; $this->container['count'] = isset($data['count']) ? $data['count'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets lists * * @return object[] */ public function getLists() { return $this->container['lists']; } /** * Sets lists * * @param object[] $lists Listing of all the lists available in your account * * @return $this */ public function setLists($lists) { $this->container['lists'] = $lists; return $this; } /** * Gets count * * @return int */ public function getCount() { return $this->container['count']; } /** * Sets count * * @param int $count Number of lists in your account * * @return $this */ public function setCount($count) { $this->container['count'] = $count; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateUpdateBatchProducts.php 0000644 00000020146 15021222673 0016024 0 ustar 00 <?php /** * CreateUpdateBatchProducts * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateUpdateBatchProducts Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchProducts implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createUpdateBatchProducts'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'products' => '\Brevo\Client\Model\CreateUpdateProducts[]', 'updateEnabled' => 'bool' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'products' => null, 'updateEnabled' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'products' => 'products', 'updateEnabled' => 'updateEnabled' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'products' => 'setProducts', 'updateEnabled' => 'setUpdateEnabled' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'products' => 'getProducts', 'updateEnabled' => 'getUpdateEnabled' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['products'] = isset($data['products']) ? $data['products'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['products'] === null) { $invalidProperties[] = "'products' can't be null"; } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets products * * @return \Brevo\Client\Model\CreateUpdateProducts[] */ public function getProducts() { return $this->container['products']; } /** * Sets products * * @param \Brevo\Client\Model\CreateUpdateProducts[] $products array of products objects * * @return $this */ public function setProducts($products) { $this->container['products'] = $products; return $this; } /** * Gets updateEnabled * * @return bool */ public function getUpdateEnabled() { return $this->container['updateEnabled']; } /** * Sets updateEnabled * * @param bool $updateEnabled Facilitate to update the existing categories in the same request (updateEnabled = true) * * @return $this */ public function setUpdateEnabled($updateEnabled) { $this->container['updateEnabled'] = $updateEnabled; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/CreateChild.php 0000644 00000030501 15021222673 0013133 0 ustar 00 <?php /** * CreateChild * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * CreateChild Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateChild implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'createChild'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ 'email' => 'string', 'firstName' => 'string', 'lastName' => 'string', 'companyName' => 'string', 'password' => 'string', 'language' => 'string' ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ 'email' => 'email', 'firstName' => null, 'lastName' => null, 'companyName' => null, 'password' => 'password', 'language' => null ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ 'email' => 'email', 'firstName' => 'firstName', 'lastName' => 'lastName', 'companyName' => 'companyName', 'password' => 'password', 'language' => 'language' ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ 'email' => 'setEmail', 'firstName' => 'setFirstName', 'lastName' => 'setLastName', 'companyName' => 'setCompanyName', 'password' => 'setPassword', 'language' => 'setLanguage' ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ 'email' => 'getEmail', 'firstName' => 'getFirstName', 'lastName' => 'getLastName', 'companyName' => 'getCompanyName', 'password' => 'getPassword', 'language' => 'getLanguage' ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } const LANGUAGE_FR = 'fr'; const LANGUAGE_ES = 'es'; const LANGUAGE_PT = 'pt'; const LANGUAGE_IT = 'it'; const LANGUAGE_DE = 'de'; const LANGUAGE_EN = 'en'; /** * Gets allowable values of the enum * * @return string[] */ public function getLanguageAllowableValues() { return [ self::LANGUAGE_FR, self::LANGUAGE_ES, self::LANGUAGE_PT, self::LANGUAGE_IT, self::LANGUAGE_DE, self::LANGUAGE_EN, ]; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { $this->container['email'] = isset($data['email']) ? $data['email'] : null; $this->container['firstName'] = isset($data['firstName']) ? $data['firstName'] : null; $this->container['lastName'] = isset($data['lastName']) ? $data['lastName'] : null; $this->container['companyName'] = isset($data['companyName']) ? $data['companyName'] : null; $this->container['password'] = isset($data['password']) ? $data['password'] : null; $this->container['language'] = isset($data['language']) ? $data['language'] : null; } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = []; if ($this->container['email'] === null) { $invalidProperties[] = "'email' can't be null"; } if ($this->container['firstName'] === null) { $invalidProperties[] = "'firstName' can't be null"; } if ($this->container['lastName'] === null) { $invalidProperties[] = "'lastName' can't be null"; } if ($this->container['companyName'] === null) { $invalidProperties[] = "'companyName' can't be null"; } if ($this->container['password'] === null) { $invalidProperties[] = "'password' can't be null"; } $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($this->container['language']) && !in_array($this->container['language'], $allowedValues, true)) { $invalidProperties[] = sprintf( "invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ); } return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Gets email * * @return string */ public function getEmail() { return $this->container['email']; } /** * Sets email * * @param string $email Email address to create the child account * * @return $this */ public function setEmail($email) { $this->container['email'] = $email; return $this; } /** * Gets firstName * * @return string */ public function getFirstName() { return $this->container['firstName']; } /** * Sets firstName * * @param string $firstName First name to use to create the child account * * @return $this */ public function setFirstName($firstName) { $this->container['firstName'] = $firstName; return $this; } /** * Gets lastName * * @return string */ public function getLastName() { return $this->container['lastName']; } /** * Sets lastName * * @param string $lastName Last name to use to create the child account * * @return $this */ public function setLastName($lastName) { $this->container['lastName'] = $lastName; return $this; } /** * Gets companyName * * @return string */ public function getCompanyName() { return $this->container['companyName']; } /** * Sets companyName * * @param string $companyName Company name to use to create the child account * * @return $this */ public function setCompanyName($companyName) { $this->container['companyName'] = $companyName; return $this; } /** * Gets password * * @return string */ public function getPassword() { return $this->container['password']; } /** * Sets password * * @param string $password Password for the child account to login * * @return $this */ public function setPassword($password) { $this->container['password'] = $password; return $this; } /** * Gets language * * @return string */ public function getLanguage() { return $this->container['language']; } /** * Sets language * * @param string $language Language of the child account * * @return $this */ public function setLanguage($language) { $allowedValues = $this->getLanguageAllowableValues(); if (!is_null($language) && !in_array($language, $allowedValues, true)) { throw new \InvalidArgumentException( sprintf( "Invalid value for 'language', must be one of '%s'", implode("', '", $allowedValues) ) ); } $this->container['language'] = $language; return $this; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/Model/NoteList.php 0000644 00000014671 15021222673 0012537 0 ustar 00 <?php /** * NoteList * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client\Model; use \ArrayAccess; use \Brevo\Client\ObjectSerializer; /** * NoteList Class Doc Comment * * @category Class * @description List of notes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteList implements ModelInterface, ArrayAccess { const DISCRIMINATOR = null; /** * The original name of the model. * * @var string */ protected static $swaggerModelName = 'NoteList'; /** * Array of property to type mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerTypes = [ ]; /** * Array of property to format mappings. Used for (de)serialization * * @var string[] */ protected static $swaggerFormats = [ ]; /** * Array of property to type mappings. Used for (de)serialization * * @return array */ public static function swaggerTypes() { return self::$swaggerTypes; } /** * Array of property to format mappings. Used for (de)serialization * * @return array */ public static function swaggerFormats() { return self::$swaggerFormats; } /** * Array of attributes where the key is the local name, * and the value is the original name * * @var string[] */ protected static $attributeMap = [ ]; /** * Array of attributes to setter functions (for deserialization of responses) * * @var string[] */ protected static $setters = [ ]; /** * Array of attributes to getter functions (for serialization of requests) * * @var string[] */ protected static $getters = [ ]; /** * Array of attributes where the key is the local name, * and the value is the original name * * @return array */ public static function attributeMap() { return self::$attributeMap; } /** * Array of attributes to setter functions (for deserialization of responses) * * @return array */ public static function setters() { return self::$setters; } /** * Array of attributes to getter functions (for serialization of requests) * * @return array */ public static function getters() { return self::$getters; } /** * The original name of the model. * * @return string */ public function getModelName() { return self::$swaggerModelName; } /** * Associative array for storing property values * * @var mixed[] */ protected $container = []; /** * Constructor * * @param mixed[] $data Associated array of property values * initializing the model */ public function __construct(array $data = null) { } /** * Show all the invalid properties with reasons. * * @return array invalid properties with reasons */ public function listInvalidProperties() { $invalidProperties = listInvalidProperties(); return $invalidProperties; } /** * Validate all the properties in the model * return true if all passed * * @return bool True if all properties are valid */ public function valid() { return count($this->listInvalidProperties()) === 0; } /** * Returns true if offset exists. False otherwise. * * @param integer $offset Offset * * @return boolean */ #[\ReturnTypeWillChange] public function offsetExists($offset) { return isset($this->container[$offset]); } /** * Gets offset. * * @param integer $offset Offset * * @return mixed */ #[\ReturnTypeWillChange] public function offsetGet($offset) { return isset($this->container[$offset]) ? $this->container[$offset] : null; } /** * Sets value based on offset. * * @param integer $offset Offset * @param mixed $value Value to be set * * @return void */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) { if (is_null($offset)) { $this->container[] = $value; } else { $this->container[$offset] = $value; } } /** * Unsets offset. * * @param integer $offset Offset * * @return void */ #[\ReturnTypeWillChange] public function offsetUnset($offset) { unset($this->container[$offset]); } /** * Gets the string presentation of the object * * @return string */ public function __toString() { if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print return json_encode( ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT ); } return json_encode(ObjectSerializer::sanitizeForSerialization($this)); } } brevo-php/lib/HeaderSelector.php 0000644 00000006646 15021222673 0012632 0 ustar 00 <?php /** * ApiException * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client; use \Exception; /** * ApiException Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class HeaderSelector { /** * @param string[] $accept * @param string[] $contentTypes * @return array */ public function selectHeaders($accept, $contentTypes) { $headers = []; $accept = $this->selectAcceptHeader($accept); if ($accept !== null) { $headers['Accept'] = $accept; } $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); return $headers; } /** * @param string[] $accept * @return array */ public function selectHeadersForMultipart($accept) { $headers = $this->selectHeaders($accept, []); unset($headers['Content-Type']); return $headers; } /** * Return the header 'Accept' based on an array of Accept provided * * @param string[] $accept Array of header * * @return string Accept (e.g. application/json) */ private function selectAcceptHeader($accept) { if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) { return null; } elseif (preg_grep("/application\/json/i", $accept)) { return 'application/json'; } else { return implode(',', $accept); } } /** * Return the content type based on an array of content-type provided * * @param string[] $contentType Array fo content-type * * @return string Content-Type (e.g. application/json) */ private function selectContentTypeHeader($contentType) { if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) { return 'application/json'; } elseif (preg_grep("/application\/json/i", $contentType)) { return 'application/json'; } else { return implode(',', $contentType); } } } brevo-php/lib/ObjectSerializer.php 0000644 00000030707 15021222673 0013174 0 ustar 00 <?php /** * ObjectSerializer * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Do not edit the class manually. */ namespace Brevo\Client; /** * ObjectSerializer Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ObjectSerializer { /** * Serialize data * * @param mixed $data the data to serialize * @param string $type the SwaggerType of the data * @param string $format the format of the Swagger type of the data * * @return string|object serialized form of $data */ public static function sanitizeForSerialization($data, $type = null, $format = null) { if (is_scalar($data) || null === $data) { return $data; } elseif ($data instanceof \DateTime) { return ($format === 'date') ? $data->format('Y-m-d') : $data->format(\DateTime::ATOM); } elseif (is_array($data)) { foreach ($data as $property => $value) { $data[$property] = self::sanitizeForSerialization($value); } return $data; } elseif ($data instanceof \stdClass) { foreach ($data as $property => $value) { $data->$property = self::sanitizeForSerialization($value); } return $data; } elseif (is_object($data)) { $values = []; $formats = $data::swaggerFormats(); foreach ($data::swaggerTypes() as $property => $swaggerType) { $getter = $data::getters()[$property]; $value = $data->$getter(); if ($value !== null && !in_array($swaggerType, ['DateTime', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true) && method_exists($swaggerType, 'getAllowableEnumValues') && !in_array($value, $swaggerType::getAllowableEnumValues(), true)) { $imploded = implode("', '", $swaggerType::getAllowableEnumValues()); throw new \InvalidArgumentException("Invalid value for enum '$swaggerType', must be one of: '$imploded'"); } if ($value !== null) { $values[$data::attributeMap()[$property]] = self::sanitizeForSerialization($value, $swaggerType, $formats[$property]); } } return (object)$values; } else { return (string)$data; } } /** * Sanitize filename by removing path. * e.g. ../../sun.gif becomes sun.gif * * @param string $filename filename to be sanitized * * @return string the sanitized filename */ public static function sanitizeFilename($filename) { if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; } else { return $filename; } } /** * Take value and turn it into a string suitable for inclusion in * the path, by url-encoding. * * @param string $value a string which will be part of the path * * @return string the serialized object */ public static function toPathValue($value) { return rawurlencode(self::toString($value)); } /** * Take value and turn it into a string suitable for inclusion in * the query, by imploding comma-separated if it's an object. * If it's a string, pass through unchanged. It will be url-encoded * later. * * @param string[]|string|\DateTime $object an object to be serialized to a string * * @return string the serialized object */ public static function toQueryValue($object) { if (is_array($object)) { return implode(',', $object); } else { return self::toString($object); } } /** * Take value and turn it into a string suitable for inclusion in * the header. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 * * @param string $value a string which will be part of the header * * @return string the header string */ public static function toHeaderValue($value) { return self::toString($value); } /** * Take value and turn it into a string suitable for inclusion in * the http body (form parameter). If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 * * @param string|\SplFileObject $value the value of the form parameter * * @return string the form string */ public static function toFormValue($value) { if ($value instanceof \SplFileObject) { return $value->getRealPath(); } else { return self::toString($value); } } /** * Take value and turn it into a string suitable for inclusion in * the parameter. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 * * @param string|\DateTime $value the value of the parameter * * @return string the header string */ public static function toString($value) { if ($value instanceof \DateTime) { // datetime in ISO8601 format return $value->format(\DateTime::ATOM); } else { return $value; } } /** * Serialize an array to a string. * * @param array $collection collection to serialize to a string * @param string $collectionFormat the format use for serialization (csv, * ssv, tsv, pipes, multi) * @param bool $allowCollectionFormatMulti allow collection format to be a multidimensional array * * @return string */ public static function serializeCollection(array $collection, $collectionFormat, $allowCollectionFormatMulti = false) { if ($allowCollectionFormatMulti && ('multi' === $collectionFormat)) { // http_build_query() almost does the job for us. We just // need to fix the result of multidimensional arrays. return preg_replace('/%5B[0-9]+%5D=/', '=', http_build_query($collection, '', '&')); } switch ($collectionFormat) { case 'pipes': return implode('|', $collection); case 'tsv': return implode("\t", $collection); case 'ssv': return implode(' ', $collection); case 'csv': // Deliberate fall through. CSV is default format. default: return implode(',', $collection); } } /** * Deserialize a JSON string into an object * * @param mixed $data object or primitive to be deserialized * @param string $class class name is passed as a string * @param string[] $httpHeaders HTTP headers * @param string $discriminator discriminator if polymorphism is used * * @return object|array|null an single or an array of $class instances */ public static function deserialize($data, $class, $httpHeaders = null) { if (null === $data) { return null; } elseif (substr($class, 0, 4) === 'map[') { // for associative array e.g. map[string,int] $inner = substr($class, 4, -1); $deserialized = []; if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = self::deserialize($value, $subClass, null); } } return $deserialized; } elseif (strcasecmp(substr($class, -2), '[]') === 0) { $subClass = substr($class, 0, -2); $values = []; foreach ($data as $key => $value) { $values[] = self::deserialize($value, $subClass, null); } return $values; } elseif ($class === 'object') { settype($data, 'array'); return $data; } elseif ($class === '\DateTime') { // Some API's return an invalid, empty string as a // date-time property. DateTime::__construct() will return // the current time for empty input which is probably not // what is meant. The invalid empty string is probably to // be interpreted as a missing field/value. Let's handle // this graceful. if (!empty($data)) { return new \DateTime($data); } else { return null; } } elseif (in_array($class, ['DateTime', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { settype($data, $class); return $data; } elseif ($class === '\SplFileObject') { /** @var \Psr\Http\Message\StreamInterface $data */ // determine file name if (array_key_exists('Content-Disposition', $httpHeaders) && preg_match('/inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeaders['Content-Disposition'], $match)) { $filename = Configuration::getDefaultConfiguration()->getTempFolderPath() . DIRECTORY_SEPARATOR . self::sanitizeFilename($match[1]); } else { $filename = tempnam(Configuration::getDefaultConfiguration()->getTempFolderPath(), ''); } $file = fopen($filename, 'w'); while ($chunk = $data->read(200)) { fwrite($file, $chunk); } fclose($file); return new \SplFileObject($filename, 'r'); } elseif (method_exists($class, 'getAllowableEnumValues')) { if (!in_array($data, $class::getAllowableEnumValues(), true)) { $imploded = implode("', '", $class::getAllowableEnumValues()); throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); } return $data; } else { // If a discriminator is defined and points to a valid subclass, use it. $discriminator = $class::DISCRIMINATOR; if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { $subclass = '\Brevo\Client\Model\\' . $data->{$discriminator}; if (is_subclass_of($subclass, $class)) { $class = $subclass; } } $instance = new $class(); foreach ($instance::swaggerTypes() as $property => $type) { $propertySetter = $instance::setters()[$property]; if (!isset($propertySetter) || !isset($data->{$instance::attributeMap()[$property]})) { continue; } $propertyValue = $data->{$instance::attributeMap()[$property]}; if (isset($propertyValue)) { $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); } } return $instance; } } } brevo-php/CHANGELOG.md 0000644 00000000664 15021222673 0010265 0 ustar 00 # Changelog ## 1.0.2 (2023-07-17) - Added Coupons route - Added **previewText** | **string** | Preview text or preheader of the email campaign | [optional] - language support for Whatsapp template creation - Making WhatsAppCampaignsApi PSR-4 compliant. ## 1.0.1 (2023-05-28) - API's changed from sendinblue.com domain to api brevo.com domain - For installation follow this process - Follow reference example in order to use this SDK brevo-php/LICENSE.md 0000644 00000002060 15021222673 0010050 0 ustar 00 The MIT License (MIT) Copyright (c) 2019 Brevo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. brevo-php/README.md 0000644 00000167706 15021222673 0007746 0 ustar 00 # Brevo's API v3 Php Library Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.brevo.com) to learn more. This is the wrapper for the API. It implements all the features of the API v3. Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition.yml). This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by Brevo: - API version: 3.0.0 - Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit [https://account.brevo.com/support](https://account.brevo.com/support) ## Requirements PHP 5.6 and later ## Installation & Usage ### Composer To install the bindings via [Composer](http://getcomposer.org/): Create a ```composer.json``` file in any directory & add below code in composer.json file. ``` { "require": { "getbrevo/brevo-php": "1.x.x" } } ``` Then run below commands in the same directory ``` composer require getbrevo/brevo-php "1.x.x" ``` Further do: * run ``composer install`` to get these dependencies added to your vendor directory * add the autoloader to your application with this line: ``require("vendor/autoload.php")`` ## Tests To run the unit tests: ``` composer install ./vendor/bin/phpunit ``` ## Getting Started Please follow the [installation procedure](#installation--usage) and then run the following: ```php <?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\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->getAccount(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL; } ?> ``` ## Documentation for API Endpoints All URIs are relative to *https://api.brevo.com/v3* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *AccountApi* | [**getAccount**](docs/Api/AccountApi.md#getaccount) | **GET** /account | Get your account information, plan and credits details *AccountApi* | [**getAccountActivity**](docs/Api/AccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs *CompaniesApi* | [**companiesAttributesGet**](docs/Api/CompaniesApi.md#companiesattributesget) | **GET** /companies/attributes | Get company attributes *CompaniesApi* | [**companiesGet**](docs/Api/CompaniesApi.md#companiesget) | **GET** /companies | Get all companies *CompaniesApi* | [**companiesIdDelete**](docs/Api/CompaniesApi.md#companiesiddelete) | **DELETE** /companies/{id} | Delete a company *CompaniesApi* | [**companiesIdGet**](docs/Api/CompaniesApi.md#companiesidget) | **GET** /companies/{id} | Get a company *CompaniesApi* | [**companiesIdPatch**](docs/Api/CompaniesApi.md#companiesidpatch) | **PATCH** /companies/{id} | Update a company *CompaniesApi* | [**companiesLinkUnlinkIdPatch**](docs/Api/CompaniesApi.md#companieslinkunlinkidpatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals *CompaniesApi* | [**companiesPost**](docs/Api/CompaniesApi.md#companiespost) | **POST** /companies | Create a company *AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *AttributesApi* | [**getAttributes**](docs/Api/AttributesApi.md#getattributes) | **GET** /contacts/attributes | List all attributes *AttributesApi* | [**updateAttribute**](docs/Api/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *CRMApi* | [**crmNotesGet**](docs/Api/CRMApi.md#crmnotesget) | **GET** /crm/notes | Get all notes *CRMApi* | [**crmNotesIdDelete**](docs/Api/CRMApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note *CRMApi* | [**crmNotesIdGet**](docs/Api/CRMApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note *CRMApi* | [**crmNotesIdPatch**](docs/Api/CRMApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note *CRMApi* | [**crmNotesPost**](docs/Api/CRMApi.md#crmnotespost) | **POST** /crm/notes | Create a note *CRMApi* | [**crmTasksGet**](docs/Api/CRMApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks *CRMApi* | [**crmTasksIdDelete**](docs/Api/CRMApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task *CRMApi* | [**crmTasksIdGet**](docs/Api/CRMApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task *CRMApi* | [**crmTasksIdPatch**](docs/Api/CRMApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task *CRMApi* | [**crmTasksPost**](docs/Api/CRMApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task *CRMApi* | [**crmTasktypesGet**](docs/Api/CRMApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types *ContactsApi* | [**addContactToList**](docs/Api/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute *ContactsApi* | [**createContact**](docs/Api/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact *ContactsApi* | [**createDoiContact**](docs/Api/ContactsApi.md#createdoicontact) | **POST** /contacts/doubleOptinConfirmation | Create Contact via DOI (Double-Opt-In) Flow *ContactsApi* | [**createFolder**](docs/Api/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder *ContactsApi* | [**createList**](docs/Api/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list *ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute *ContactsApi* | [**deleteContact**](docs/Api/ContactsApi.md#deletecontact) | **DELETE** /contacts/{identifier} | Delete a contact *ContactsApi* | [**deleteFolder**](docs/Api/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *ContactsApi* | [**deleteList**](docs/Api/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list *ContactsApi* | [**getAttributes**](docs/Api/ContactsApi.md#getattributes) | **GET** /contacts/attributes | List all attributes *ContactsApi* | [**getContactInfo**](docs/Api/ContactsApi.md#getcontactinfo) | **GET** /contacts/{identifier} | Get a contact's details *ContactsApi* | [**getContactStats**](docs/Api/ContactsApi.md#getcontactstats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact *ContactsApi* | [**getContacts**](docs/Api/ContactsApi.md#getcontacts) | **GET** /contacts | Get all the contacts *ContactsApi* | [**getContactsFromList**](docs/Api/ContactsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list *ContactsApi* | [**getFolder**](docs/Api/ContactsApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details *ContactsApi* | [**getFolderLists**](docs/Api/ContactsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *ContactsApi* | [**getFolders**](docs/Api/ContactsApi.md#getfolders) | **GET** /contacts/folders | Get all folders *ContactsApi* | [**getList**](docs/Api/ContactsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ContactsApi* | [**getLists**](docs/Api/ContactsApi.md#getlists) | **GET** /contacts/lists | Get all the lists *ContactsApi* | [**getSegments**](docs/Api/ContactsApi.md#getsegments) | **GET** /contacts/segments | Get all the Segments *ContactsApi* | [**importContacts**](docs/Api/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts *ContactsApi* | [**removeContactFromList**](docs/Api/ContactsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ContactsApi* | [**requestContactExport**](docs/Api/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts *ContactsApi* | [**updateAttribute**](docs/Api/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute *ContactsApi* | [**updateBatchContacts**](docs/Api/ContactsApi.md#updatebatchcontacts) | **POST** /contacts/batch | Update multiple contacts *ContactsApi* | [**updateContact**](docs/Api/ContactsApi.md#updatecontact) | **PUT** /contacts/{identifier} | Update a contact *ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *ConversationsApi* | [**conversationsAgentOnlinePingPost**](docs/Api/ConversationsApi.md#conversationsagentonlinepingpost) | **POST** /conversations/agentOnlinePing | Sets agent’s status to online for 2-3 minutes *ConversationsApi* | [**conversationsMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationsmessagesiddelete) | **DELETE** /conversations/messages/{id} | Delete a message sent by an agent *ConversationsApi* | [**conversationsMessagesIdGet**](docs/Api/ConversationsApi.md#conversationsmessagesidget) | **GET** /conversations/messages/{id} | Get a message *ConversationsApi* | [**conversationsMessagesIdPut**](docs/Api/ConversationsApi.md#conversationsmessagesidput) | **PUT** /conversations/messages/{id} | Update a message sent by an agent *ConversationsApi* | [**conversationsMessagesPost**](docs/Api/ConversationsApi.md#conversationsmessagespost) | **POST** /conversations/messages | Send a message as an agent *ConversationsApi* | [**conversationsPushedMessagesIdDelete**](docs/Api/ConversationsApi.md#conversationspushedmessagesiddelete) | **DELETE** /conversations/pushedMessages/{id} | Delete an automated message *ConversationsApi* | [**conversationsPushedMessagesIdGet**](docs/Api/ConversationsApi.md#conversationspushedmessagesidget) | **GET** /conversations/pushedMessages/{id} | Get an automated message *ConversationsApi* | [**conversationsPushedMessagesIdPut**](docs/Api/ConversationsApi.md#conversationspushedmessagesidput) | **PUT** /conversations/pushedMessages/{id} | Update an automated message *ConversationsApi* | [**conversationsPushedMessagesPost**](docs/Api/ConversationsApi.md#conversationspushedmessagespost) | **POST** /conversations/pushedMessages | Send an automated message to a visitor *CouponsApi* | [**createCouponCollection**](docs/Api/CouponsApi.md#createcouponcollection) | **POST** /couponCollections | Create а coupon collection *CouponsApi* | [**createCoupons**](docs/Api/CouponsApi.md#createcoupons) | **POST** /coupons | Create coupons for a coupon collection *CouponsApi* | [**getCouponCollection**](docs/Api/CouponsApi.md#getcouponcollection) | **GET** /couponCollections/{id} | Get a coupon collection by id *CouponsApi* | [**getCouponCollections**](docs/Api/CouponsApi.md#getcouponcollections) | **GET** /couponCollections | Get all your coupon collections *CouponsApi* | [**updateCouponCollection**](docs/Api/CouponsApi.md#updatecouponcollection) | **PATCH** /couponCollections/{id} | Update a coupon collection by id *DealsApi* | [**crmAttributesDealsGet**](docs/Api/DealsApi.md#crmattributesdealsget) | **GET** /crm/attributes/deals | Get deal attributes *DealsApi* | [**crmDealsGet**](docs/Api/DealsApi.md#crmdealsget) | **GET** /crm/deals | Get all deals *DealsApi* | [**crmDealsIdDelete**](docs/Api/DealsApi.md#crmdealsiddelete) | **DELETE** /crm/deals/{id} | Delete a deal *DealsApi* | [**crmDealsIdGet**](docs/Api/DealsApi.md#crmdealsidget) | **GET** /crm/deals/{id} | Get a deal *DealsApi* | [**crmDealsIdPatch**](docs/Api/DealsApi.md#crmdealsidpatch) | **PATCH** /crm/deals/{id} | Update a deal *DealsApi* | [**crmDealsLinkUnlinkIdPatch**](docs/Api/DealsApi.md#crmdealslinkunlinkidpatch) | **PATCH** /crm/deals/link-unlink/{id} | Link and Unlink a deal with contacts and companies *DealsApi* | [**crmDealsPost**](docs/Api/DealsApi.md#crmdealspost) | **POST** /crm/deals | Create a deal *DealsApi* | [**crmPipelineDetailsAllGet**](docs/Api/DealsApi.md#crmpipelinedetailsallget) | **GET** /crm/pipeline/details/all | Get all pipelines *DealsApi* | [**crmPipelineDetailsGet**](docs/Api/DealsApi.md#crmpipelinedetailsget) | **GET** /crm/pipeline/details | Get pipeline stages *DealsApi* | [**crmPipelineDetailsPipelineIDGet**](docs/Api/DealsApi.md#crmpipelinedetailspipelineidget) | **GET** /crm/pipeline/details/{pipelineID} | Get a pipeline *DomainsApi* | [**authenticateDomain**](docs/Api/DomainsApi.md#authenticatedomain) | **PUT** /senders/domains/{domainName}/authenticate | Authenticate a domain *DomainsApi* | [**createDomain**](docs/Api/DomainsApi.md#createdomain) | **POST** /senders/domains | Create a new domain *DomainsApi* | [**deleteDomain**](docs/Api/DomainsApi.md#deletedomain) | **DELETE** /senders/domains/{domainName} | Delete a domain *DomainsApi* | [**getDomainConfiguration**](docs/Api/DomainsApi.md#getdomainconfiguration) | **GET** /senders/domains/{domainName} | Validate domain configuration *DomainsApi* | [**getDomains**](docs/Api/DomainsApi.md#getdomains) | **GET** /senders/domains | Get the list of all your domains *EcommerceApi* | [**createBatchOrder**](docs/Api/EcommerceApi.md#createbatchorder) | **POST** /orders/status/batch | Create orders in batch *EcommerceApi* | [**createOrder**](docs/Api/EcommerceApi.md#createorder) | **POST** /orders/status | Managing the status of the order *EcommerceApi* | [**createUpdateBatchCategory**](docs/Api/EcommerceApi.md#createupdatebatchcategory) | **POST** /categories/batch | Create categories in batch *EcommerceApi* | [**createUpdateBatchProducts**](docs/Api/EcommerceApi.md#createupdatebatchproducts) | **POST** /products/batch | Create products in batch *EcommerceApi* | [**createUpdateCategory**](docs/Api/EcommerceApi.md#createupdatecategory) | **POST** /categories | Create/Update a category *EcommerceApi* | [**createUpdateProduct**](docs/Api/EcommerceApi.md#createupdateproduct) | **POST** /products | Create/Update a product *EcommerceApi* | [**ecommerceActivatePost**](docs/Api/EcommerceApi.md#ecommerceactivatepost) | **POST** /ecommerce/activate | Activate the eCommerce app *EcommerceApi* | [**getCategories**](docs/Api/EcommerceApi.md#getcategories) | **GET** /categories | Return all your categories *EcommerceApi* | [**getCategoryInfo**](docs/Api/EcommerceApi.md#getcategoryinfo) | **GET** /categories/{id} | Get a category details *EcommerceApi* | [**getProductInfo**](docs/Api/EcommerceApi.md#getproductinfo) | **GET** /products/{id} | Get a product's details *EcommerceApi* | [**getProducts**](docs/Api/EcommerceApi.md#getproducts) | **GET** /products | Return all your products *EmailCampaignsApi* | [**createEmailCampaign**](docs/Api/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign *EmailCampaignsApi* | [**deleteEmailCampaign**](docs/Api/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign *EmailCampaignsApi* | [**emailExportRecipients**](docs/Api/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of an email campaign *EmailCampaignsApi* | [**getAbTestCampaignResult**](docs/Api/EmailCampaignsApi.md#getabtestcampaignresult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get an A/B test email campaign results *EmailCampaignsApi* | [**getEmailCampaign**](docs/Api/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get an email campaign report *EmailCampaignsApi* | [**getEmailCampaigns**](docs/Api/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created email campaigns *EmailCampaignsApi* | [**getSharedTemplateUrl**](docs/Api/EmailCampaignsApi.md#getsharedtemplateurl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url *EmailCampaignsApi* | [**sendEmailCampaignNow**](docs/Api/EmailCampaignsApi.md#sendemailcampaignnow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId *EmailCampaignsApi* | [**sendReport**](docs/Api/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaign *EmailCampaignsApi* | [**sendTestEmail**](docs/Api/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list *EmailCampaignsApi* | [**updateCampaignStatus**](docs/Api/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status *EmailCampaignsApi* | [**updateEmailCampaign**](docs/Api/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign *EmailCampaignsApi* | [**uploadImageToGallery**](docs/Api/EmailCampaignsApi.md#uploadimagetogallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery *FoldersApi* | [**createFolder**](docs/Api/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder *FoldersApi* | [**deleteFolder**](docs/Api/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *FoldersApi* | [**getFolder**](docs/Api/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns a folder's details *FoldersApi* | [**getFolderLists**](docs/Api/FoldersApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *FoldersApi* | [**getFolders**](docs/Api/FoldersApi.md#getfolders) | **GET** /contacts/folders | Get all folders *FoldersApi* | [**updateFolder**](docs/Api/FoldersApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a folder *ExternalFeedsApi* | [**createExternalFeed**](docs/Api/ExternalFeedsApi.md#createexternalfeed) | **POST** /feeds | Create an external feed *ExternalFeedsApi* | [**deleteExternalFeed**](docs/Api/ExternalFeedsApi.md#deleteexternalfeed) | **DELETE** /feeds/{uuid} | Delete an external feed *ExternalFeedsApi* | [**getAllExternalFeeds**](docs/Api/ExternalFeedsApi.md#getallexternalfeeds) | **GET** /feeds | Fetch all external feeds *ExternalFeedsApi* | [**getExternalFeedByUUID**](docs/Api/ExternalFeedsApi.md#getexternalfeedbyuuid) | **GET** /feeds/{uuid} | Get an external feed by UUID *ExternalFeedsApi* | [**updateExternalFeed**](docs/Api/ExternalFeedsApi.md#updateexternalfeed) | **PUT** /feeds/{uuid} | Update an external feed *FilesApi* | [**crmFilesGet**](docs/Api/FilesApi.md#crmfilesget) | **GET** /crm/files | Get all files *FilesApi* | [**crmFilesIdDataGet**](docs/Api/FilesApi.md#crmfilesiddataget) | **GET** /crm/files/{id}/data | Get file details *FilesApi* | [**crmFilesIdDelete**](docs/Api/FilesApi.md#crmfilesiddelete) | **DELETE** /crm/files/{id} | Delete a file *FilesApi* | [**crmFilesIdGet**](docs/Api/FilesApi.md#crmfilesidget) | **GET** /crm/files/{id} | Download a file *FilesApi* | [**crmFilesPost**](docs/Api/FilesApi.md#crmfilespost) | **POST** /crm/files | Upload a file *InboundParsingApi* | [**getInboundEmailAttachment**](docs/Api/InboundParsingApi.md#getinboundemailattachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token. *InboundParsingApi* | [**getInboundEmailEvents**](docs/Api/InboundParsingApi.md#getinboundemailevents) | **GET** /inbound/events | Get the list of all the events for the received emails. *InboundParsingApi* | [**getInboundEmailEventsByUuid**](docs/Api/InboundParsingApi.md#getinboundemaileventsbyuuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email. *ListsApi* | [**addContactToList**](docs/Api/ListsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list *ListsApi* | [**createList**](docs/Api/ListsApi.md#createlist) | **POST** /contacts/lists | Create a list *ListsApi* | [**deleteList**](docs/Api/ListsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list *ListsApi* | [**getContactsFromList**](docs/Api/ListsApi.md#getcontactsfromlist) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list *ListsApi* | [**getFolderLists**](docs/Api/ListsApi.md#getfolderlists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder *ListsApi* | [**getList**](docs/Api/ListsApi.md#getlist) | **GET** /contacts/lists/{listId} | Get a list's details *ListsApi* | [**getLists**](docs/Api/ListsApi.md#getlists) | **GET** /contacts/lists | Get all the lists *ListsApi* | [**removeContactFromList**](docs/Api/ListsApi.md#removecontactfromlist) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list *ListsApi* | [**updateList**](docs/Api/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *MasterAccountApi* | [**corporateMasterAccountGet**](docs/Api/MasterAccountApi.md#corporatemasteraccountget) | **GET** /corporate/masterAccount | Get the details of requested master account *MasterAccountApi* | [**corporateSubAccountGet**](docs/Api/MasterAccountApi.md#corporatesubaccountget) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account. *MasterAccountApi* | [**corporateSubAccountIdApplicationsTogglePut**](docs/Api/MasterAccountApi.md#corporatesubaccountidapplicationstoggleput) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s) *MasterAccountApi* | [**corporateSubAccountIdDelete**](docs/Api/MasterAccountApi.md#corporatesubaccountiddelete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account *MasterAccountApi* | [**corporateSubAccountIdGet**](docs/Api/MasterAccountApi.md#corporatesubaccountidget) | **GET** /corporate/subAccount/{id} | Get sub-account details *MasterAccountApi* | [**corporateSubAccountIdPlanPut**](docs/Api/MasterAccountApi.md#corporatesubaccountidplanput) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan *MasterAccountApi* | [**corporateSubAccountKeyPost**](docs/Api/MasterAccountApi.md#corporatesubaccountkeypost) | **POST** /corporate/subAccount/key | Create an API key for a sub-account *MasterAccountApi* | [**corporateSubAccountPost**](docs/Api/MasterAccountApi.md#corporatesubaccountpost) | **POST** /corporate/subAccount | Create a new sub-account under a master account. *MasterAccountApi* | [**corporateSubAccountSsoTokenPost**](docs/Api/MasterAccountApi.md#corporatesubaccountssotokenpost) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo *MasterAccountApi* | [**getAccountActivity**](docs/Api/MasterAccountApi.md#getaccountactivity) | **GET** /organization/activities | Get user activity logs *NotesApi* | [**crmNotesGet**](docs/Api/NotesApi.md#crmnotesget) | **GET** /crm/notes | Get all notes *NotesApi* | [**crmNotesIdDelete**](docs/Api/NotesApi.md#crmnotesiddelete) | **DELETE** /crm/notes/{id} | Delete a note *NotesApi* | [**crmNotesIdGet**](docs/Api/NotesApi.md#crmnotesidget) | **GET** /crm/notes/{id} | Get a note *NotesApi* | [**crmNotesIdPatch**](docs/Api/NotesApi.md#crmnotesidpatch) | **PATCH** /crm/notes/{id} | Update a note *NotesApi* | [**crmNotesPost**](docs/Api/NotesApi.md#crmnotespost) | **POST** /crm/notes | Create a note *ProcessApi* | [**getProcess**](docs/Api/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process *ProcessApi* | [**getProcesses**](docs/Api/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account *ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childIdentifier}/credits/add | Add Email and/or SMS credits to a specific child account *ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childIdentifier}/ips/associate | Associate a dedicated IP to the child *ResellerApi* | [**createChildDomain**](docs/Api/ResellerApi.md#createchilddomain) | **POST** /reseller/children/{childIdentifier}/domains | Create a domain for a child account *ResellerApi* | [**createResellerChild**](docs/Api/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child *ResellerApi* | [**deleteChildDomain**](docs/Api/ResellerApi.md#deletechilddomain) | **DELETE** /reseller/children/{childIdentifier}/domains/{domainName} | Delete the sender domain of the reseller child based on the childIdentifier and domainName passed *ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childIdentifier} | Delete a single reseller child based on the child identifier supplied *ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childIdentifier}/ips/dissociate | Dissociate a dedicated IP to the child *ResellerApi* | [**getChildAccountCreationStatus**](docs/Api/ResellerApi.md#getchildaccountcreationstatus) | **GET** /reseller/children/{childIdentifier}/accountCreationStatus | Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied *ResellerApi* | [**getChildDomains**](docs/Api/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childIdentifier}/domains | Get all sender domains for a specific child account *ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childIdentifier} | Get a child account's details *ResellerApi* | [**getResellerChilds**](docs/Api/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Get the list of all children accounts *ResellerApi* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childIdentifier}/auth | Get session token to access Brevo (SSO) *ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childIdentifier}/credits/remove | Remove Email and/or SMS credits from a specific child account *ResellerApi* | [**updateChildAccountStatus**](docs/Api/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childIdentifier}/accountStatus | Update info of reseller's child account status based on the childIdentifier supplied *ResellerApi* | [**updateChildDomain**](docs/Api/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childIdentifier}/domains/{domainName} | Update the sender domain of reseller's child based on the childIdentifier and domainName passed *ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childIdentifier} | Update info of reseller's child based on the child identifier supplied *SMSCampaignsApi* | [**createSmsCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign *SMSCampaignsApi* | [**deleteSmsCampaign**](docs/Api/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete an SMS campaign *SMSCampaignsApi* | [**getSmsCampaign**](docs/Api/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign *SMSCampaignsApi* | [**getSmsCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the information for all your created SMS campaigns *SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Export an SMS campaign's recipients *SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately *SMSCampaignsApi* | [**sendSmsReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send an SMS campaign's report *SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send a test SMS campaign *SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Update an SMS campaign *SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update a campaign's status *SendersApi* | [**createSender**](docs/Api/SendersApi.md#createsender) | **POST** /senders | Create a new sender *SendersApi* | [**deleteSender**](docs/Api/SendersApi.md#deletesender) | **DELETE** /senders/{senderId} | Delete a sender *SendersApi* | [**getIps**](docs/Api/SendersApi.md#getips) | **GET** /senders/ips | Get all the dedicated IPs for your account *SendersApi* | [**getIpsFromSender**](docs/Api/SendersApi.md#getipsfromsender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender *SendersApi* | [**getSenders**](docs/Api/SendersApi.md#getsenders) | **GET** /senders | Get the list of all your senders *SendersApi* | [**updateSender**](docs/Api/SendersApi.md#updatesender) | **PUT** /senders/{senderId} | Update a sender *SendersApi* | [**validateSenderByOTP**](docs/Api/SendersApi.md#validatesenderbyotp) | **PUT** /senders/{senderId}/validate | Update a sender *TasksApi* | [**crmTasksGet**](docs/Api/TasksApi.md#crmtasksget) | **GET** /crm/tasks | Get all tasks *TasksApi* | [**crmTasksIdDelete**](docs/Api/TasksApi.md#crmtasksiddelete) | **DELETE** /crm/tasks/{id} | Delete a task *TasksApi* | [**crmTasksIdGet**](docs/Api/TasksApi.md#crmtasksidget) | **GET** /crm/tasks/{id} | Get a task *TasksApi* | [**crmTasksIdPatch**](docs/Api/TasksApi.md#crmtasksidpatch) | **PATCH** /crm/tasks/{id} | Update a task *TasksApi* | [**crmTasksPost**](docs/Api/TasksApi.md#crmtaskspost) | **POST** /crm/tasks | Create a task *TasksApi* | [**crmTasktypesGet**](docs/Api/TasksApi.md#crmtasktypesget) | **GET** /crm/tasktypes | Get all task types *TransactionalEmailsApi* | [**blockNewDomain**](docs/Api/TransactionalEmailsApi.md#blocknewdomain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains *TransactionalEmailsApi* | [**createSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an email template *TransactionalEmailsApi* | [**deleteBlockedDomain**](docs/Api/TransactionalEmailsApi.md#deleteblockeddomain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains *TransactionalEmailsApi* | [**deleteHardbounces**](docs/Api/TransactionalEmailsApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces *TransactionalEmailsApi* | [**deleteScheduledEmailById**](docs/Api/TransactionalEmailsApi.md#deletescheduledemailbyid) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId *TransactionalEmailsApi* | [**deleteSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template *TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/Api/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time *TransactionalEmailsApi* | [**getBlockedDomains**](docs/Api/TransactionalEmailsApi.md#getblockeddomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains *TransactionalEmailsApi* | [**getEmailEventReport**](docs/Api/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events) *TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbybatchid) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId *TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbymessageid) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId *TransactionalEmailsApi* | [**getSmtpReport**](docs/Api/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day *TransactionalEmailsApi* | [**getSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information *TransactionalEmailsApi* | [**getSmtpTemplates**](docs/Api/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates *TransactionalEmailsApi* | [**getTransacBlockedContacts**](docs/Api/TransactionalEmailsApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts *TransactionalEmailsApi* | [**getTransacEmailContent**](docs/Api/TransactionalEmailsApi.md#gettransacemailcontent) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email *TransactionalEmailsApi* | [**getTransacEmailsList**](docs/Api/TransactionalEmailsApi.md#gettransacemailslist) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters *TransactionalEmailsApi* | [**sendTestTemplate**](docs/Api/TransactionalEmailsApi.md#sendtesttemplate) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list *TransactionalEmailsApi* | [**sendTransacEmail**](docs/Api/TransactionalEmailsApi.md#sendtransacemail) | **POST** /smtp/email | Send a transactional email *TransactionalEmailsApi* | [**smtpBlockedContactsEmailDelete**](docs/Api/TransactionalEmailsApi.md#smtpblockedcontactsemaildelete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact *TransactionalEmailsApi* | [**smtpLogMessageIdDelete**](docs/Api/TransactionalEmailsApi.md#smtplogmessageiddelete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log *TransactionalEmailsApi* | [**updateSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#updatesmtptemplate) | **PUT** /smtp/templates/{templateId} | Update an email template *TransactionalSMSApi* | [**getSmsEvents**](docs/Api/TransactionalSMSApi.md#getsmsevents) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) *TransactionalSMSApi* | [**getTransacAggregatedSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacaggregatedsmsreport) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time *TransactionalSMSApi* | [**getTransacSmsReport**](docs/Api/TransactionalSMSApi.md#gettransacsmsreport) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day *TransactionalSMSApi* | [**sendTransacSms**](docs/Api/TransactionalSMSApi.md#sendtransacsms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number *TransactionalWhatsAppApi* | [**getWhatsappEventReport**](docs/Api/TransactionalWhatsAppApi.md#getwhatsappeventreport) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events) *TransactionalWhatsAppApi* | [**sendWhatsappMessage**](docs/Api/TransactionalWhatsAppApi.md#sendwhatsappmessage) | **POST** /whatsapp/sendMessage | Send a WhatsApp message *UserApi* | [**getInvitedUsersList**](docs/Api/UserApi.md#getinviteduserslist) | **GET** /organization/invited/users | Get the list of all your users *UserApi* | [**getUserPermission**](docs/Api/UserApi.md#getuserpermission) | **GET** /organization/user/{email}/permissions | Check user permission *WebhooksApi* | [**createWebhook**](docs/Api/WebhooksApi.md#createwebhook) | **POST** /webhooks | Create a webhook *WebhooksApi* | [**deleteWebhook**](docs/Api/WebhooksApi.md#deletewebhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook *WebhooksApi* | [**exportWebhooksHistory**](docs/Api/WebhooksApi.md#exportwebhookshistory) | **POST** /webhooks/export | Export all transactional events *WebhooksApi* | [**getWebhook**](docs/Api/WebhooksApi.md#getwebhook) | **GET** /webhooks/{webhookId} | Get a webhook details *WebhooksApi* | [**getWebhooks**](docs/Api/WebhooksApi.md#getwebhooks) | **GET** /webhooks | Get all webhooks *WebhooksApi* | [**updateWebhook**](docs/Api/WebhooksApi.md#updatewebhook) | **PUT** /webhooks/{webhookId} | Update a webhook *WhatsAppCampaignsApi* | [**createWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#createwhatsappcampaign) | **POST** /whatsappCampaigns | Create and Send a WhatsApp campaign *WhatsAppCampaignsApi* | [**createWhatsAppTemplate**](docs/Api/WhatsAppCampaignsApi.md#createwhatsapptemplate) | **POST** /whatsppCampaigns/template | Create a WhatsApp template *WhatsAppCampaignsApi* | [**deleteWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#deletewhatsappcampaign) | **DELETE** /whatsappCampaigns/{campaignId} | Delete a WhatsApp campaign *WhatsAppCampaignsApi* | [**getWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaign) | **GET** /whatsappCampaigns/{campaignId} | Get a WhatsApp campaign *WhatsAppCampaignsApi* | [**getWhatsAppCampaigns**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappcampaigns) | **GET** /whatsappCampaigns | Return all your created WhatsApp campaigns *WhatsAppCampaignsApi* | [**getWhatsAppConfig**](docs/Api/WhatsAppCampaignsApi.md#getwhatsappconfig) | **GET** /whatsappCampaigns/config | Get your WhatsApp API account information *WhatsAppCampaignsApi* | [**getWhatsAppTemplates**](docs/Api/WhatsAppCampaignsApi.md#getwhatsapptemplates) | **GET** /whatsappCampaigns/template-list | Return all your created WhatsApp templates *WhatsAppCampaignsApi* | [**sendWhatsAppTemplateApproval**](docs/Api/WhatsAppCampaignsApi.md#sendwhatsapptemplateapproval) | **POST** /whatsappCampaigns/template/approval/{templateId} | Send your WhatsApp template for approval *WhatsAppCampaignsApi* | [**updateWhatsAppCampaign**](docs/Api/WhatsAppCampaignsApi.md#updatewhatsappcampaign) | **PUT** /whatsappCampaigns/{campaignId} | Update a WhatsApp campaign ## Documentation For Models - [AbTestCampaignResult](docs/Model/AbTestCampaignResult.md) - [AbTestCampaignResultClickedLinks](docs/Model/AbTestCampaignResultClickedLinks.md) - [AbTestCampaignResultStatistics](docs/Model/AbTestCampaignResultStatistics.md) - [AbTestVersionClicks](docs/Model/AbTestVersionClicks.md) - [AbTestVersionClicksInner](docs/Model/AbTestVersionClicksInner.md) - [AbTestVersionStats](docs/Model/AbTestVersionStats.md) - [AddChildDomain](docs/Model/AddChildDomain.md) - [AddContactToList](docs/Model/AddContactToList.md) - [AddCredits](docs/Model/AddCredits.md) - [AuthenticateDomainModel](docs/Model/AuthenticateDomainModel.md) - [BlockDomain](docs/Model/BlockDomain.md) - [Body](docs/Model/Body.md) - [Body1](docs/Model/Body1.md) - [Body10](docs/Model/Body10.md) - [Body11](docs/Model/Body11.md) - [Body12](docs/Model/Body12.md) - [Body2](docs/Model/Body2.md) - [Body3](docs/Model/Body3.md) - [Body4](docs/Model/Body4.md) - [Body5](docs/Model/Body5.md) - [Body6](docs/Model/Body6.md) - [Body7](docs/Model/Body7.md) - [Body8](docs/Model/Body8.md) - [Body9](docs/Model/Body9.md) - [BodyVariablesItems](docs/Model/BodyVariablesItems.md) - [CompaniesList](docs/Model/CompaniesList.md) - [Company](docs/Model/Company.md) - [CompanyAttributes](docs/Model/CompanyAttributes.md) - [CompanyAttributesInner](docs/Model/CompanyAttributesInner.md) - [ComponentItems](docs/Model/ComponentItems.md) - [ConversationsMessage](docs/Model/ConversationsMessage.md) - [ConversationsMessageFile](docs/Model/ConversationsMessageFile.md) - [ConversationsMessageFileImageInfo](docs/Model/ConversationsMessageFileImageInfo.md) - [CreateApiKeyRequest](docs/Model/CreateApiKeyRequest.md) - [CreateApiKeyResponse](docs/Model/CreateApiKeyResponse.md) - [CreateAttribute](docs/Model/CreateAttribute.md) - [CreateAttributeEnumeration](docs/Model/CreateAttributeEnumeration.md) - [CreateCategoryModel](docs/Model/CreateCategoryModel.md) - [CreateChild](docs/Model/CreateChild.md) - [CreateContact](docs/Model/CreateContact.md) - [CreateCouponCollection](docs/Model/CreateCouponCollection.md) - [CreateCoupons](docs/Model/CreateCoupons.md) - [CreateDoiContact](docs/Model/CreateDoiContact.md) - [CreateDomain](docs/Model/CreateDomain.md) - [CreateDomainModel](docs/Model/CreateDomainModel.md) - [CreateDomainModelDnsRecords](docs/Model/CreateDomainModelDnsRecords.md) - [CreateDomainModelDnsRecordsDkimRecord](docs/Model/CreateDomainModelDnsRecordsDkimRecord.md) - [CreateEmailCampaign](docs/Model/CreateEmailCampaign.md) - [CreateEmailCampaignRecipients](docs/Model/CreateEmailCampaignRecipients.md) - [CreateEmailCampaignSender](docs/Model/CreateEmailCampaignSender.md) - [CreateExternalFeed](docs/Model/CreateExternalFeed.md) - [CreateList](docs/Model/CreateList.md) - [CreateModel](docs/Model/CreateModel.md) - [CreateProductModel](docs/Model/CreateProductModel.md) - [CreateReseller](docs/Model/CreateReseller.md) - [CreateSender](docs/Model/CreateSender.md) - [CreateSenderIps](docs/Model/CreateSenderIps.md) - [CreateSenderModel](docs/Model/CreateSenderModel.md) - [CreateSmsCampaign](docs/Model/CreateSmsCampaign.md) - [CreateSmsCampaignRecipients](docs/Model/CreateSmsCampaignRecipients.md) - [CreateSmtpEmail](docs/Model/CreateSmtpEmail.md) - [CreateSmtpTemplate](docs/Model/CreateSmtpTemplate.md) - [CreateSmtpTemplateSender](docs/Model/CreateSmtpTemplateSender.md) - [CreateSubAccount](docs/Model/CreateSubAccount.md) - [CreateSubAccountResponse](docs/Model/CreateSubAccountResponse.md) - [CreateUpdateBatchCategory](docs/Model/CreateUpdateBatchCategory.md) - [CreateUpdateBatchCategoryModel](docs/Model/CreateUpdateBatchCategoryModel.md) - [CreateUpdateBatchProducts](docs/Model/CreateUpdateBatchProducts.md) - [CreateUpdateBatchProductsModel](docs/Model/CreateUpdateBatchProductsModel.md) - [CreateUpdateCategories](docs/Model/CreateUpdateCategories.md) - [CreateUpdateCategory](docs/Model/CreateUpdateCategory.md) - [CreateUpdateContactModel](docs/Model/CreateUpdateContactModel.md) - [CreateUpdateFolder](docs/Model/CreateUpdateFolder.md) - [CreateUpdateProduct](docs/Model/CreateUpdateProduct.md) - [CreateUpdateProducts](docs/Model/CreateUpdateProducts.md) - [CreateWebhook](docs/Model/CreateWebhook.md) - [CreateWhatsAppCampaign](docs/Model/CreateWhatsAppCampaign.md) - [CreateWhatsAppCampaignRecipients](docs/Model/CreateWhatsAppCampaignRecipients.md) - [CreateWhatsAppTemplate](docs/Model/CreateWhatsAppTemplate.md) - [CreatedBatchId](docs/Model/CreatedBatchId.md) - [CreatedProcessId](docs/Model/CreatedProcessId.md) - [Deal](docs/Model/Deal.md) - [DealAttributes](docs/Model/DealAttributes.md) - [DealAttributesInner](docs/Model/DealAttributesInner.md) - [DealsList](docs/Model/DealsList.md) - [DeleteHardbounces](docs/Model/DeleteHardbounces.md) - [EmailExportRecipients](docs/Model/EmailExportRecipients.md) - [ErrorModel](docs/Model/ErrorModel.md) - [ExportWebhooksHistory](docs/Model/ExportWebhooksHistory.md) - [FileData](docs/Model/FileData.md) - [FileDownloadableLink](docs/Model/FileDownloadableLink.md) - [FileList](docs/Model/FileList.md) - [GetAccount](docs/Model/GetAccount.md) - [GetAccountActivity](docs/Model/GetAccountActivity.md) - [GetAccountActivityLogs](docs/Model/GetAccountActivityLogs.md) - [GetAccountMarketingAutomation](docs/Model/GetAccountMarketingAutomation.md) - [GetAccountPlan](docs/Model/GetAccountPlan.md) - [GetAccountRelay](docs/Model/GetAccountRelay.md) - [GetAccountRelayData](docs/Model/GetAccountRelayData.md) - [GetAggregatedReport](docs/Model/GetAggregatedReport.md) - [GetAllExternalFeeds](docs/Model/GetAllExternalFeeds.md) - [GetAllExternalFeedsFeeds](docs/Model/GetAllExternalFeedsFeeds.md) - [GetAttributes](docs/Model/GetAttributes.md) - [GetAttributesAttributes](docs/Model/GetAttributesAttributes.md) - [GetAttributesEnumeration](docs/Model/GetAttributesEnumeration.md) - [GetBlockedDomains](docs/Model/GetBlockedDomains.md) - [GetCampaignOverview](docs/Model/GetCampaignOverview.md) - [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md) - [GetCampaignStats](docs/Model/GetCampaignStats.md) - [GetCategories](docs/Model/GetCategories.md) - [GetCategoryDetails](docs/Model/GetCategoryDetails.md) - [GetChildAccountCreationStatus](docs/Model/GetChildAccountCreationStatus.md) - [GetChildDomain](docs/Model/GetChildDomain.md) - [GetChildDomains](docs/Model/GetChildDomains.md) - [GetChildInfo](docs/Model/GetChildInfo.md) - [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md) - [GetChildInfoApiKeysV2](docs/Model/GetChildInfoApiKeysV2.md) - [GetChildInfoApiKeysV3](docs/Model/GetChildInfoApiKeysV3.md) - [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md) - [GetChildInfoStatistics](docs/Model/GetChildInfoStatistics.md) - [GetChildrenList](docs/Model/GetChildrenList.md) - [GetClient](docs/Model/GetClient.md) - [GetContactCampaignStats](docs/Model/GetContactCampaignStats.md) - [GetContactCampaignStatsClicked](docs/Model/GetContactCampaignStatsClicked.md) - [GetContactCampaignStatsOpened](docs/Model/GetContactCampaignStatsOpened.md) - [GetContactCampaignStatsTransacAttributes](docs/Model/GetContactCampaignStatsTransacAttributes.md) - [GetContactCampaignStatsUnsubscriptions](docs/Model/GetContactCampaignStatsUnsubscriptions.md) - [GetContactDetails](docs/Model/GetContactDetails.md) - [GetContacts](docs/Model/GetContacts.md) - [GetCouponCollection](docs/Model/GetCouponCollection.md) - [GetDeviceBrowserStats](docs/Model/GetDeviceBrowserStats.md) - [GetDomainConfigurationModel](docs/Model/GetDomainConfigurationModel.md) - [GetDomainsList](docs/Model/GetDomainsList.md) - [GetDomainsListDomains](docs/Model/GetDomainsListDomains.md) - [GetEmailCampaign](docs/Model/GetEmailCampaign.md) - [GetEmailCampaigns](docs/Model/GetEmailCampaigns.md) - [GetEmailEventReport](docs/Model/GetEmailEventReport.md) - [GetEmailEventReportEvents](docs/Model/GetEmailEventReportEvents.md) - [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md) - [GetExtendedCampaignOverviewSender](docs/Model/GetExtendedCampaignOverviewSender.md) - [GetExtendedCampaignStats](docs/Model/GetExtendedCampaignStats.md) - [GetExtendedCampaignStatsGlobalStats](docs/Model/GetExtendedCampaignStatsGlobalStats.md) - [GetExtendedClient](docs/Model/GetExtendedClient.md) - [GetExtendedClientAddress](docs/Model/GetExtendedClientAddress.md) - [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md) - [GetExtendedContactDetailsStatistics](docs/Model/GetExtendedContactDetailsStatistics.md) - [GetExtendedContactDetailsStatisticsClicked](docs/Model/GetExtendedContactDetailsStatisticsClicked.md) - [GetExtendedContactDetailsStatisticsDelivered](docs/Model/GetExtendedContactDetailsStatisticsDelivered.md) - [GetExtendedContactDetailsStatisticsLinks](docs/Model/GetExtendedContactDetailsStatisticsLinks.md) - [GetExtendedContactDetailsStatisticsMessagesSent](docs/Model/GetExtendedContactDetailsStatisticsMessagesSent.md) - [GetExtendedContactDetailsStatisticsOpened](docs/Model/GetExtendedContactDetailsStatisticsOpened.md) - [GetExtendedContactDetailsStatisticsUnsubscriptions](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptions.md) - [GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md) - [GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md) - [GetExtendedList](docs/Model/GetExtendedList.md) - [GetExtendedListCampaignStats](docs/Model/GetExtendedListCampaignStats.md) - [GetExternalFeedByUUID](docs/Model/GetExternalFeedByUUID.md) - [GetExternalFeedByUUIDHeaders](docs/Model/GetExternalFeedByUUIDHeaders.md) - [GetFolder](docs/Model/GetFolder.md) - [GetFolderLists](docs/Model/GetFolderLists.md) - [GetFolders](docs/Model/GetFolders.md) - [GetInboundEmailEvents](docs/Model/GetInboundEmailEvents.md) - [GetInboundEmailEventsByUuid](docs/Model/GetInboundEmailEventsByUuid.md) - [GetInboundEmailEventsByUuidAttachments](docs/Model/GetInboundEmailEventsByUuidAttachments.md) - [GetInboundEmailEventsByUuidLogs](docs/Model/GetInboundEmailEventsByUuidLogs.md) - [GetInboundEmailEventsEvents](docs/Model/GetInboundEmailEventsEvents.md) - [GetInvitedUsersList](docs/Model/GetInvitedUsersList.md) - [GetInvitedUsersListFeatureAccess](docs/Model/GetInvitedUsersListFeatureAccess.md) - [GetInvitedUsersListUsers](docs/Model/GetInvitedUsersListUsers.md) - [GetIp](docs/Model/GetIp.md) - [GetIpFromSender](docs/Model/GetIpFromSender.md) - [GetIps](docs/Model/GetIps.md) - [GetIpsFromSender](docs/Model/GetIpsFromSender.md) - [GetList](docs/Model/GetList.md) - [GetLists](docs/Model/GetLists.md) - [GetProcess](docs/Model/GetProcess.md) - [GetProcesses](docs/Model/GetProcesses.md) - [GetProductDetails](docs/Model/GetProductDetails.md) - [GetProducts](docs/Model/GetProducts.md) - [GetReports](docs/Model/GetReports.md) - [GetReportsReports](docs/Model/GetReportsReports.md) - [GetScheduledEmailByBatchId](docs/Model/GetScheduledEmailByBatchId.md) - [GetScheduledEmailByBatchIdBatches](docs/Model/GetScheduledEmailByBatchIdBatches.md) - [GetScheduledEmailByMessageId](docs/Model/GetScheduledEmailByMessageId.md) - [GetSegments](docs/Model/GetSegments.md) - [GetSegmentsSegments](docs/Model/GetSegmentsSegments.md) - [GetSendersList](docs/Model/GetSendersList.md) - [GetSendersListIps](docs/Model/GetSendersListIps.md) - [GetSendersListSenders](docs/Model/GetSendersListSenders.md) - [GetSharedTemplateUrl](docs/Model/GetSharedTemplateUrl.md) - [GetSmsCampaign](docs/Model/GetSmsCampaign.md) - [GetSmsCampaignOverview](docs/Model/GetSmsCampaignOverview.md) - [GetSmsCampaignRecipients](docs/Model/GetSmsCampaignRecipients.md) - [GetSmsCampaignStats](docs/Model/GetSmsCampaignStats.md) - [GetSmsCampaigns](docs/Model/GetSmsCampaigns.md) - [GetSmsEventReport](docs/Model/GetSmsEventReport.md) - [GetSmsEventReportEvents](docs/Model/GetSmsEventReportEvents.md) - [GetSmtpTemplateOverview](docs/Model/GetSmtpTemplateOverview.md) - [GetSmtpTemplateOverviewSender](docs/Model/GetSmtpTemplateOverviewSender.md) - [GetSmtpTemplates](docs/Model/GetSmtpTemplates.md) - [GetSsoToken](docs/Model/GetSsoToken.md) - [GetStatsByBrowser](docs/Model/GetStatsByBrowser.md) - [GetStatsByDevice](docs/Model/GetStatsByDevice.md) - [GetStatsByDomain](docs/Model/GetStatsByDomain.md) - [GetTransacAggregatedSmsReport](docs/Model/GetTransacAggregatedSmsReport.md) - [GetTransacBlockedContacts](docs/Model/GetTransacBlockedContacts.md) - [GetTransacBlockedContactsContacts](docs/Model/GetTransacBlockedContactsContacts.md) - [GetTransacBlockedContactsReason](docs/Model/GetTransacBlockedContactsReason.md) - [GetTransacEmailContent](docs/Model/GetTransacEmailContent.md) - [GetTransacEmailContentEvents](docs/Model/GetTransacEmailContentEvents.md) - [GetTransacEmailsList](docs/Model/GetTransacEmailsList.md) - [GetTransacEmailsListTransactionalEmails](docs/Model/GetTransacEmailsListTransactionalEmails.md) - [GetTransacSmsReport](docs/Model/GetTransacSmsReport.md) - [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md) - [GetUserPermission](docs/Model/GetUserPermission.md) - [GetUserPermissionPrivileges](docs/Model/GetUserPermissionPrivileges.md) - [GetWATemplates](docs/Model/GetWATemplates.md) - [GetWATemplatesTemplates](docs/Model/GetWATemplatesTemplates.md) - [GetWebhook](docs/Model/GetWebhook.md) - [GetWebhooks](docs/Model/GetWebhooks.md) - [GetWhatsAppConfig](docs/Model/GetWhatsAppConfig.md) - [GetWhatsappCampaignOverview](docs/Model/GetWhatsappCampaignOverview.md) - [GetWhatsappCampaigns](docs/Model/GetWhatsappCampaigns.md) - [GetWhatsappCampaignsCampaigns](docs/Model/GetWhatsappCampaignsCampaigns.md) - [GetWhatsappEventReport](docs/Model/GetWhatsappEventReport.md) - [GetWhatsappEventReportEvents](docs/Model/GetWhatsappEventReportEvents.md) - [InlineResponse200](docs/Model/InlineResponse200.md) - [InlineResponse2001](docs/Model/InlineResponse2001.md) - [InlineResponse201](docs/Model/InlineResponse201.md) - [InlineResponse2011](docs/Model/InlineResponse2011.md) - [InlineResponse2012](docs/Model/InlineResponse2012.md) - [InlineResponse2013](docs/Model/InlineResponse2013.md) - [InlineResponse2014](docs/Model/InlineResponse2014.md) - [ManageIp](docs/Model/ManageIp.md) - [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md) - [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md) - [MasterDetailsResponseBillingInfoAddress](docs/Model/MasterDetailsResponseBillingInfoAddress.md) - [MasterDetailsResponseBillingInfoName](docs/Model/MasterDetailsResponseBillingInfoName.md) - [MasterDetailsResponsePlanInfo](docs/Model/MasterDetailsResponsePlanInfo.md) - [MasterDetailsResponsePlanInfoFeatures](docs/Model/MasterDetailsResponsePlanInfoFeatures.md) - [Note](docs/Model/Note.md) - [NoteData](docs/Model/NoteData.md) - [NoteId](docs/Model/NoteId.md) - [NoteList](docs/Model/NoteList.md) - [Order](docs/Model/Order.md) - [OrderBatch](docs/Model/OrderBatch.md) - [OrderBilling](docs/Model/OrderBilling.md) - [OrderProducts](docs/Model/OrderProducts.md) - [Otp](docs/Model/Otp.md) - [Pipeline](docs/Model/Pipeline.md) - [PipelineStage](docs/Model/PipelineStage.md) - [Pipelines](docs/Model/Pipelines.md) - [PostContactInfo](docs/Model/PostContactInfo.md) - [PostContactInfoContacts](docs/Model/PostContactInfoContacts.md) - [PostSendFailed](docs/Model/PostSendFailed.md) - [PostSendSmsTestFailed](docs/Model/PostSendSmsTestFailed.md) - [RemainingCreditModel](docs/Model/RemainingCreditModel.md) - [RemainingCreditModelChild](docs/Model/RemainingCreditModelChild.md) - [RemainingCreditModelReseller](docs/Model/RemainingCreditModelReseller.md) - [RemoveContactFromList](docs/Model/RemoveContactFromList.md) - [RemoveCredits](docs/Model/RemoveCredits.md) - [RequestContactExport](docs/Model/RequestContactExport.md) - [RequestContactExportCustomContactFilter](docs/Model/RequestContactExportCustomContactFilter.md) - [RequestContactImport](docs/Model/RequestContactImport.md) - [RequestContactImportJsonBody](docs/Model/RequestContactImportJsonBody.md) - [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md) - [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md) - [ScheduleSmtpEmail](docs/Model/ScheduleSmtpEmail.md) - [SendReport](docs/Model/SendReport.md) - [SendReportEmail](docs/Model/SendReportEmail.md) - [SendSms](docs/Model/SendSms.md) - [SendSmtpEmail](docs/Model/SendSmtpEmail.md) - [SendSmtpEmailAttachment](docs/Model/SendSmtpEmailAttachment.md) - [SendSmtpEmailBcc](docs/Model/SendSmtpEmailBcc.md) - [SendSmtpEmailCc](docs/Model/SendSmtpEmailCc.md) - [SendSmtpEmailMessageVersions](docs/Model/SendSmtpEmailMessageVersions.md) - [SendSmtpEmailReplyTo](docs/Model/SendSmtpEmailReplyTo.md) - [SendSmtpEmailReplyTo1](docs/Model/SendSmtpEmailReplyTo1.md) - [SendSmtpEmailSender](docs/Model/SendSmtpEmailSender.md) - [SendSmtpEmailTo](docs/Model/SendSmtpEmailTo.md) - [SendSmtpEmailTo1](docs/Model/SendSmtpEmailTo1.md) - [SendTestEmail](docs/Model/SendTestEmail.md) - [SendTestSms](docs/Model/SendTestSms.md) - [SendTransacSms](docs/Model/SendTransacSms.md) - [SendWhatsappMessage](docs/Model/SendWhatsappMessage.md) - [SsoTokenRequest](docs/Model/SsoTokenRequest.md) - [SubAccountAppsToggleRequest](docs/Model/SubAccountAppsToggleRequest.md) - [SubAccountDetailsResponse](docs/Model/SubAccountDetailsResponse.md) - [SubAccountDetailsResponsePlanInfo](docs/Model/SubAccountDetailsResponsePlanInfo.md) - [SubAccountDetailsResponsePlanInfoCredits](docs/Model/SubAccountDetailsResponsePlanInfoCredits.md) - [SubAccountDetailsResponsePlanInfoCreditsEmails](docs/Model/SubAccountDetailsResponsePlanInfoCreditsEmails.md) - [SubAccountDetailsResponsePlanInfoFeatures](docs/Model/SubAccountDetailsResponsePlanInfoFeatures.md) - [SubAccountDetailsResponsePlanInfoFeaturesInbox](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesInbox.md) - [SubAccountDetailsResponsePlanInfoFeaturesLandingPage](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) - [SubAccountDetailsResponsePlanInfoFeaturesUsers](docs/Model/SubAccountDetailsResponsePlanInfoFeaturesUsers.md) - [SubAccountUpdatePlanRequest](docs/Model/SubAccountUpdatePlanRequest.md) - [SubAccountUpdatePlanRequestCredits](docs/Model/SubAccountUpdatePlanRequestCredits.md) - [SubAccountUpdatePlanRequestFeatures](docs/Model/SubAccountUpdatePlanRequestFeatures.md) - [SubAccountsResponse](docs/Model/SubAccountsResponse.md) - [SubAccountsResponseSubAccounts](docs/Model/SubAccountsResponseSubAccounts.md) - [Task](docs/Model/Task.md) - [TaskList](docs/Model/TaskList.md) - [TaskReminder](docs/Model/TaskReminder.md) - [TaskTypes](docs/Model/TaskTypes.md) - [UpdateAttribute](docs/Model/UpdateAttribute.md) - [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md) - [UpdateBatchContacts](docs/Model/UpdateBatchContacts.md) - [UpdateBatchContactsContacts](docs/Model/UpdateBatchContactsContacts.md) - [UpdateBatchContactsModel](docs/Model/UpdateBatchContactsModel.md) - [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md) - [UpdateChild](docs/Model/UpdateChild.md) - [UpdateChildAccountStatus](docs/Model/UpdateChildAccountStatus.md) - [UpdateChildDomain](docs/Model/UpdateChildDomain.md) - [UpdateContact](docs/Model/UpdateContact.md) - [UpdateCouponCollection](docs/Model/UpdateCouponCollection.md) - [UpdateEmailCampaign](docs/Model/UpdateEmailCampaign.md) - [UpdateEmailCampaignRecipients](docs/Model/UpdateEmailCampaignRecipients.md) - [UpdateEmailCampaignSender](docs/Model/UpdateEmailCampaignSender.md) - [UpdateExternalFeed](docs/Model/UpdateExternalFeed.md) - [UpdateList](docs/Model/UpdateList.md) - [UpdateSender](docs/Model/UpdateSender.md) - [UpdateSmsCampaign](docs/Model/UpdateSmsCampaign.md) - [UpdateSmtpTemplate](docs/Model/UpdateSmtpTemplate.md) - [UpdateSmtpTemplateSender](docs/Model/UpdateSmtpTemplateSender.md) - [UpdateWebhook](docs/Model/UpdateWebhook.md) - [UpdateWhatsAppCampaign](docs/Model/UpdateWhatsAppCampaign.md) - [UploadImageModel](docs/Model/UploadImageModel.md) - [UploadImageToGallery](docs/Model/UploadImageToGallery.md) - [GetChildInfo](docs/Model/GetChildInfo.md) - [GetExtendedCampaignOverview](docs/Model/GetExtendedCampaignOverview.md) - [GetExtendedClient](docs/Model/GetExtendedClient.md) - [GetExtendedContactDetails](docs/Model/GetExtendedContactDetails.md) - [GetExtendedList](docs/Model/GetExtendedList.md) - [GetSmsCampaign](docs/Model/GetSmsCampaign.md) - [GetAccount](docs/Model/GetAccount.md) - [GetEmailCampaign](docs/Model/GetEmailCampaign.md) - [VariablesItems](docs/Model/VariablesItems.md) - [WhatsappCampStats](docs/Model/WhatsappCampStats.md) - [WhatsappCampTemplate](docs/Model/WhatsappCampTemplate.md) ## Documentation For Authorization ## api-key The API key should be passed in the request headers as `api-key` for authentication. - **Type**: API key - **API key parameter name**: api-key - **Location**: HTTP header ## partner-key The partner key should be passed in the request headers as `partner-key` along with `api-key` pair for successful authentication of partner (Optional). - **Type**: API key - **API key parameter name**: partner-key - **Location**: HTTP header If you find a bug, please post the issue on [Github](https://github.com/getbrevo/brevo-php/issues). As always, if you need additional assistance, drop us a note [here](https://account.brevo.com/support). brevo-php/test/Api/DomainsApiTest.php 0000644 00000005666 15021222673 0013550 0 ustar 00 <?php /** * DomainsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * DomainsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DomainsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for authenticateDomain * * Authenticate a domain. * */ public function testAuthenticateDomain() { } /** * Test case for createDomain * * Create a new domain. * */ public function testCreateDomain() { } /** * Test case for deleteDomain * * Delete a domain. * */ public function testDeleteDomain() { } /** * Test case for getDomainConfiguration * * Validate domain configuration. * */ public function testGetDomainConfiguration() { } /** * Test case for getDomains * * Get the list of all your domains. * */ public function testGetDomains() { } } brevo-php/test/Api/ExternalFeedsApiTest.php 0000644 00000005765 15021222673 0014707 0 ustar 00 <?php /** * ExternalFeedsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ExternalFeedsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ExternalFeedsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createExternalFeed * * Create an external feed. * */ public function testCreateExternalFeed() { } /** * Test case for deleteExternalFeed * * Delete an external feed. * */ public function testDeleteExternalFeed() { } /** * Test case for getAllExternalFeeds * * Fetch all external feeds. * */ public function testGetAllExternalFeeds() { } /** * Test case for getExternalFeedByUUID * * Get an external feed by UUID. * */ public function testGetExternalFeedByUUID() { } /** * Test case for updateExternalFeed * * Update an external feed. * */ public function testUpdateExternalFeed() { } } brevo-php/test/Api/ResellerApiTest.php 0000644 00000012364 15021222673 0013724 0 ustar 00 <?php /** * ResellerApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ResellerApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ResellerApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for addCredits * * Add Email and/or SMS credits to a specific child account. * */ public function testAddCredits() { } /** * Test case for associateIpToChild * * Associate a dedicated IP to the child. * */ public function testAssociateIpToChild() { } /** * Test case for createChildDomain * * Create a domain for a child account. * */ public function testCreateChildDomain() { } /** * Test case for createResellerChild * * Creates a reseller child. * */ public function testCreateResellerChild() { } /** * Test case for deleteChildDomain * * Delete the sender domain of the reseller child based on the childIdentifier and domainName passed. * */ public function testDeleteChildDomain() { } /** * Test case for deleteResellerChild * * Delete a single reseller child based on the child identifier supplied. * */ public function testDeleteResellerChild() { } /** * Test case for dissociateIpFromChild * * Dissociate a dedicated IP to the child. * */ public function testDissociateIpFromChild() { } /** * Test case for getChildAccountCreationStatus * * Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the identifier supplied. * */ public function testGetChildAccountCreationStatus() { } /** * Test case for getChildDomains * * Get all sender domains for a specific child account. * */ public function testGetChildDomains() { } /** * Test case for getChildInfo * * Get a child account's details. * */ public function testGetChildInfo() { } /** * Test case for getResellerChilds * * Get the list of all children accounts. * */ public function testGetResellerChilds() { } /** * Test case for getSsoToken * * Get session token to access Brevo (SSO). * */ public function testGetSsoToken() { } /** * Test case for removeCredits * * Remove Email and/or SMS credits from a specific child account. * */ public function testRemoveCredits() { } /** * Test case for updateChildAccountStatus * * Update info of reseller's child account status based on the childIdentifier supplied. * */ public function testUpdateChildAccountStatus() { } /** * Test case for updateChildDomain * * Update the sender domain of reseller's child based on the childIdentifier and domainName passed. * */ public function testUpdateChildDomain() { } /** * Test case for updateResellerChild * * Update info of reseller's child based on the child identifier supplied. * */ public function testUpdateResellerChild() { } } brevo-php/test/Api/CompaniesApiTest.php 0000644 00000006401 15021222673 0014060 0 ustar 00 <?php /** * CompaniesApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * CompaniesApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompaniesApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for companiesAttributesGet * * Get company attributes. * */ public function testCompaniesAttributesGet() { } /** * Test case for companiesGet * * Get all companies. * */ public function testCompaniesGet() { } /** * Test case for companiesIdDelete * * Delete a company. * */ public function testCompaniesIdDelete() { } /** * Test case for companiesIdGet * * Get a company. * */ public function testCompaniesIdGet() { } /** * Test case for companiesIdPatch * * Update a company. * */ public function testCompaniesIdPatch() { } /** * Test case for companiesLinkUnlinkIdPatch * * Link and Unlink company with contacts and deals. * */ public function testCompaniesLinkUnlinkIdPatch() { } /** * Test case for companiesPost * * Create a company. * */ public function testCompaniesPost() { } } brevo-php/test/Api/TasksApiTest.php 0000644 00000006001 15021222673 0013223 0 ustar 00 <?php /** * TasksApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * TasksApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TasksApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for crmTasksGet * * Get all tasks. * */ public function testCrmTasksGet() { } /** * Test case for crmTasksIdDelete * * Delete a task. * */ public function testCrmTasksIdDelete() { } /** * Test case for crmTasksIdGet * * Get a task. * */ public function testCrmTasksIdGet() { } /** * Test case for crmTasksIdPatch * * Update a task. * */ public function testCrmTasksIdPatch() { } /** * Test case for crmTasksPost * * Create a task. * */ public function testCrmTasksPost() { } /** * Test case for crmTasktypesGet * * Get all task types. * */ public function testCrmTasktypesGet() { } } brevo-php/test/Api/SMSCampaignsApiTest.php 0000644 00000007456 15021222673 0014442 0 ustar 00 <?php /** * SMSCampaignsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * SMSCampaignsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SMSCampaignsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createSmsCampaign * * Creates an SMS campaign. * */ public function testCreateSmsCampaign() { } /** * Test case for deleteSmsCampaign * * Delete an SMS campaign. * */ public function testDeleteSmsCampaign() { } /** * Test case for getSmsCampaign * * Get an SMS campaign. * */ public function testGetSmsCampaign() { } /** * Test case for getSmsCampaigns * * Returns the information for all your created SMS campaigns. * */ public function testGetSmsCampaigns() { } /** * Test case for requestSmsRecipientExport * * Export an SMS campaign's recipients. * */ public function testRequestSmsRecipientExport() { } /** * Test case for sendSmsCampaignNow * * Send your SMS campaign immediately. * */ public function testSendSmsCampaignNow() { } /** * Test case for sendSmsReport * * Send an SMS campaign's report. * */ public function testSendSmsReport() { } /** * Test case for sendTestSms * * Send a test SMS campaign. * */ public function testSendTestSms() { } /** * Test case for updateSmsCampaign * * Update an SMS campaign. * */ public function testUpdateSmsCampaign() { } /** * Test case for updateSmsCampaignStatus * * Update a campaign's status. * */ public function testUpdateSmsCampaignStatus() { } } brevo-php/test/Api/TransactionalSMSApiTest.php 0000644 00000005650 15021222673 0015334 0 ustar 00 <?php /** * TransactionalSMSApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * TransactionalSMSApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalSMSApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getSmsEvents * * Get all your SMS activity (unaggregated events). * */ public function testGetSmsEvents() { } /** * Test case for getTransacAggregatedSmsReport * * Get your SMS activity aggregated over a period of time. * */ public function testGetTransacAggregatedSmsReport() { } /** * Test case for getTransacSmsReport * * Get your SMS activity aggregated per day. * */ public function testGetTransacSmsReport() { } /** * Test case for sendTransacSms * * Send SMS message to a mobile number. * */ public function testSendTransacSms() { } } brevo-php/test/Api/ListsApiTest.php 0000644 00000006724 15021222673 0013250 0 ustar 00 <?php /** * ListsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ListsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ListsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for addContactToList * * Add existing contacts to a list. * */ public function testAddContactToList() { } /** * Test case for createList * * Create a list. * */ public function testCreateList() { } /** * Test case for deleteList * * Delete a list. * */ public function testDeleteList() { } /** * Test case for getContactsFromList * * Get contacts in a list. * */ public function testGetContactsFromList() { } /** * Test case for getFolderLists * * Get lists in a folder. * */ public function testGetFolderLists() { } /** * Test case for getList * * Get a list's details. * */ public function testGetList() { } /** * Test case for getLists * * Get all the lists. * */ public function testGetLists() { } /** * Test case for removeContactFromList * * Delete a contact from a list. * */ public function testRemoveContactFromList() { } /** * Test case for updateList * * Update a list. * */ public function testUpdateList() { } } brevo-php/test/Api/InboundParsingApiTest.php 0000644 00000005455 15021222673 0015074 0 ustar 00 <?php /** * InboundParsingApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * InboundParsingApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InboundParsingApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getInboundEmailAttachment * * Retrieve inbound attachment with download token.. * */ public function testGetInboundEmailAttachment() { } /** * Test case for getInboundEmailEvents * * Get the list of all the events for the received emails.. * */ public function testGetInboundEmailEvents() { } /** * Test case for getInboundEmailEventsByUuid * * Fetch all events history for one particular received email.. * */ public function testGetInboundEmailEventsByUuid() { } } brevo-php/test/Api/DealsApiTest.php 0000644 00000007320 15021222673 0013173 0 ustar 00 <?php /** * DealsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * DealsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for crmAttributesDealsGet * * Get deal attributes. * */ public function testCrmAttributesDealsGet() { } /** * Test case for crmDealsGet * * Get all deals. * */ public function testCrmDealsGet() { } /** * Test case for crmDealsIdDelete * * Delete a deal. * */ public function testCrmDealsIdDelete() { } /** * Test case for crmDealsIdGet * * Get a deal. * */ public function testCrmDealsIdGet() { } /** * Test case for crmDealsIdPatch * * Update a deal. * */ public function testCrmDealsIdPatch() { } /** * Test case for crmDealsLinkUnlinkIdPatch * * Link and Unlink a deal with contacts and companies. * */ public function testCrmDealsLinkUnlinkIdPatch() { } /** * Test case for crmDealsPost * * Create a deal. * */ public function testCrmDealsPost() { } /** * Test case for crmPipelineDetailsAllGet * * Get all pipelines. * */ public function testCrmPipelineDetailsAllGet() { } /** * Test case for crmPipelineDetailsGet * * Get pipeline stages. * */ public function testCrmPipelineDetailsGet() { } /** * Test case for crmPipelineDetailsPipelineIDGet * * Get a pipeline. * */ public function testCrmPipelineDetailsPipelineIDGet() { } } brevo-php/test/Api/WebhooksApiTest.php 0000644 00000006054 15021222673 0013727 0 ustar 00 <?php /** * WebhooksApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * WebhooksApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WebhooksApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createWebhook * * Create a webhook. * */ public function testCreateWebhook() { } /** * Test case for deleteWebhook * * Delete a webhook. * */ public function testDeleteWebhook() { } /** * Test case for exportWebhooksHistory * * Export all transactional events. * */ public function testExportWebhooksHistory() { } /** * Test case for getWebhook * * Get a webhook details. * */ public function testGetWebhook() { } /** * Test case for getWebhooks * * Get all webhooks. * */ public function testGetWebhooks() { } /** * Test case for updateWebhook * * Update a webhook. * */ public function testUpdateWebhook() { } } brevo-php/test/Api/TransactionalWhatsAppApiTest.php 0000644 00000005106 15021222673 0016415 0 ustar 00 <?php /** * TransactionalWhatsAppApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * TransactionalWhatsAppApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalWhatsAppApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getWhatsappEventReport * * Get all your WhatsApp activity (unaggregated events). * */ public function testGetWhatsappEventReport() { } /** * Test case for sendWhatsappMessage * * Send a WhatsApp message. * */ public function testSendWhatsappMessage() { } } brevo-php/test/Api/FilesApiTest.php 0000644 00000005570 15021222673 0013212 0 ustar 00 <?php /** * FilesApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * FilesApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FilesApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for crmFilesGet * * Get all files. * */ public function testCrmFilesGet() { } /** * Test case for crmFilesIdDataGet * * Get file details. * */ public function testCrmFilesIdDataGet() { } /** * Test case for crmFilesIdDelete * * Delete a file. * */ public function testCrmFilesIdDelete() { } /** * Test case for crmFilesIdGet * * Download a file. * */ public function testCrmFilesIdGet() { } /** * Test case for crmFilesPost * * Upload a file. * */ public function testCrmFilesPost() { } } brevo-php/test/Api/MasterAccountApiTest.php 0000644 00000010051 15021222673 0014706 0 ustar 00 <?php /** * MasterAccountApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * MasterAccountApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterAccountApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for corporateMasterAccountGet * * Get the details of requested master account. * */ public function testCorporateMasterAccountGet() { } /** * Test case for corporateSubAccountGet * * Get the list of all the sub-accounts of the master account.. * */ public function testCorporateSubAccountGet() { } /** * Test case for corporateSubAccountIdApplicationsTogglePut * * Enable/disable sub-account application(s). * */ public function testCorporateSubAccountIdApplicationsTogglePut() { } /** * Test case for corporateSubAccountIdDelete * * Delete a sub-account. * */ public function testCorporateSubAccountIdDelete() { } /** * Test case for corporateSubAccountIdGet * * Get sub-account details. * */ public function testCorporateSubAccountIdGet() { } /** * Test case for corporateSubAccountIdPlanPut * * Update sub-account plan. * */ public function testCorporateSubAccountIdPlanPut() { } /** * Test case for corporateSubAccountKeyPost * * Create an API key for a sub-account. * */ public function testCorporateSubAccountKeyPost() { } /** * Test case for corporateSubAccountPost * * Create a new sub-account under a master account.. * */ public function testCorporateSubAccountPost() { } /** * Test case for corporateSubAccountSsoTokenPost * * Generate SSO token to access Brevo. * */ public function testCorporateSubAccountSsoTokenPost() { } /** * Test case for getAccountActivity * * Get user activity logs. * */ public function testGetAccountActivity() { } } brevo-php/test/Api/FoldersApiTest.php 0000644 00000006034 15021222673 0013542 0 ustar 00 <?php /** * FoldersApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * FoldersApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FoldersApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createFolder * * Create a folder. * */ public function testCreateFolder() { } /** * Test case for deleteFolder * * Delete a folder (and all its lists). * */ public function testDeleteFolder() { } /** * Test case for getFolder * * Returns a folder's details. * */ public function testGetFolder() { } /** * Test case for getFolderLists * * Get lists in a folder. * */ public function testGetFolderLists() { } /** * Test case for getFolders * * Get all folders. * */ public function testGetFolders() { } /** * Test case for updateFolder * * Update a folder. * */ public function testUpdateFolder() { } } brevo-php/test/Api/UserApiTest.php 0000644 00000004761 15021222673 0013067 0 ustar 00 <?php /** * UserApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * UserApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UserApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getInvitedUsersList * * Get the list of all your users. * */ public function testGetInvitedUsersList() { } /** * Test case for getUserPermission * * Check user permission. * */ public function testGetUserPermission() { } } brevo-php/test/Api/NotesApiTest.php 0000644 00000005554 15021222673 0013242 0 ustar 00 <?php /** * NotesApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * NotesApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NotesApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for crmNotesGet * * Get all notes. * */ public function testCrmNotesGet() { } /** * Test case for crmNotesIdDelete * * Delete a note. * */ public function testCrmNotesIdDelete() { } /** * Test case for crmNotesIdGet * * Get a note. * */ public function testCrmNotesIdGet() { } /** * Test case for crmNotesIdPatch * * Update a note. * */ public function testCrmNotesIdPatch() { } /** * Test case for crmNotesPost * * Create a note. * */ public function testCrmNotesPost() { } } brevo-php/test/Api/EmailCampaignsApiTest.php 0000644 00000010603 15021222673 0015013 0 ustar 00 <?php /** * EmailCampaignsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * EmailCampaignsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EmailCampaignsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createEmailCampaign * * Create an email campaign. * */ public function testCreateEmailCampaign() { } /** * Test case for deleteEmailCampaign * * Delete an email campaign. * */ public function testDeleteEmailCampaign() { } /** * Test case for emailExportRecipients * * Export the recipients of an email campaign. * */ public function testEmailExportRecipients() { } /** * Test case for getAbTestCampaignResult * * Get an A/B test email campaign results. * */ public function testGetAbTestCampaignResult() { } /** * Test case for getEmailCampaign * * Get an email campaign report. * */ public function testGetEmailCampaign() { } /** * Test case for getEmailCampaigns * * Return all your created email campaigns. * */ public function testGetEmailCampaigns() { } /** * Test case for getSharedTemplateUrl * * Get a shared template url. * */ public function testGetSharedTemplateUrl() { } /** * Test case for sendEmailCampaignNow * * Send an email campaign immediately, based on campaignId. * */ public function testSendEmailCampaignNow() { } /** * Test case for sendReport * * Send the report of a campaign. * */ public function testSendReport() { } /** * Test case for sendTestEmail * * Send an email campaign to your test list. * */ public function testSendTestEmail() { } /** * Test case for updateCampaignStatus * * Update an email campaign status. * */ public function testUpdateCampaignStatus() { } /** * Test case for updateEmailCampaign * * Update an email campaign. * */ public function testUpdateEmailCampaign() { } /** * Test case for uploadImageToGallery * * Upload an image to your account's image gallery. * */ public function testUploadImageToGallery() { } } brevo-php/test/Api/CouponsApiTest.php 0000644 00000006013 15021222673 0013567 0 ustar 00 <?php /** * CouponsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * CouponsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CouponsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createCouponCollection * * Create а coupon collection. * */ public function testCreateCouponCollection() { } /** * Test case for createCoupons * * Create coupons for a coupon collection. * */ public function testCreateCoupons() { } /** * Test case for getCouponCollection * * Get a coupon collection by id. * */ public function testGetCouponCollection() { } /** * Test case for getCouponCollections * * Get all your coupon collections. * */ public function testGetCouponCollections() { } /** * Test case for updateCouponCollection * * Update a coupon collection by id. * */ public function testUpdateCouponCollection() { } } brevo-php/test/Api/SendersApiTest.php 0000644 00000006326 15021222673 0013553 0 ustar 00 <?php /** * SendersApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * SendersApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendersApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createSender * * Create a new sender. * */ public function testCreateSender() { } /** * Test case for deleteSender * * Delete a sender. * */ public function testDeleteSender() { } /** * Test case for getIps * * Get all the dedicated IPs for your account. * */ public function testGetIps() { } /** * Test case for getIpsFromSender * * Get all the dedicated IPs for a sender. * */ public function testGetIpsFromSender() { } /** * Test case for getSenders * * Get the list of all your senders. * */ public function testGetSenders() { } /** * Test case for updateSender * * Update a sender. * */ public function testUpdateSender() { } /** * Test case for validateSenderByOTP * * Update a sender. * */ public function testValidateSenderByOTP() { } } brevo-php/test/Api/ProcessApiTest.php 0000644 00000004771 15021222673 0013570 0 ustar 00 <?php /** * ProcessApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ProcessApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ProcessApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getProcess * * Return the informations for a process. * */ public function testGetProcess() { } /** * Test case for getProcesses * * Return all the processes for your account. * */ public function testGetProcesses() { } } brevo-php/test/Api/CRMApiTest.php 0000644 00000007270 15021222673 0012570 0 ustar 00 <?php /** * CRMApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * CRMApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CRMApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for crmNotesGet * * Get all notes. * */ public function testCrmNotesGet() { } /** * Test case for crmNotesIdDelete * * Delete a note. * */ public function testCrmNotesIdDelete() { } /** * Test case for crmNotesIdGet * * Get a note. * */ public function testCrmNotesIdGet() { } /** * Test case for crmNotesIdPatch * * Update a note. * */ public function testCrmNotesIdPatch() { } /** * Test case for crmNotesPost * * Create a note. * */ public function testCrmNotesPost() { } /** * Test case for crmTasksGet * * Get all tasks. * */ public function testCrmTasksGet() { } /** * Test case for crmTasksIdDelete * * Delete a task. * */ public function testCrmTasksIdDelete() { } /** * Test case for crmTasksIdGet * * Get a task. * */ public function testCrmTasksIdGet() { } /** * Test case for crmTasksIdPatch * * Update a task. * */ public function testCrmTasksIdPatch() { } /** * Test case for crmTasksPost * * Create a task. * */ public function testCrmTasksPost() { } /** * Test case for crmTasktypesGet * * Get all task types. * */ public function testCrmTasktypesGet() { } } brevo-php/test/Api/ConversationsApiTest.php 0000644 00000007570 15021222673 0015007 0 ustar 00 <?php /** * ConversationsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ConversationsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for conversationsAgentOnlinePingPost * * Sets agent’s status to online for 2-3 minutes. * */ public function testConversationsAgentOnlinePingPost() { } /** * Test case for conversationsMessagesIdDelete * * Delete a message sent by an agent. * */ public function testConversationsMessagesIdDelete() { } /** * Test case for conversationsMessagesIdGet * * Get a message. * */ public function testConversationsMessagesIdGet() { } /** * Test case for conversationsMessagesIdPut * * Update a message sent by an agent. * */ public function testConversationsMessagesIdPut() { } /** * Test case for conversationsMessagesPost * * Send a message as an agent. * */ public function testConversationsMessagesPost() { } /** * Test case for conversationsPushedMessagesIdDelete * * Delete an automated message. * */ public function testConversationsPushedMessagesIdDelete() { } /** * Test case for conversationsPushedMessagesIdGet * * Get an automated message. * */ public function testConversationsPushedMessagesIdGet() { } /** * Test case for conversationsPushedMessagesIdPut * * Update an automated message. * */ public function testConversationsPushedMessagesIdPut() { } /** * Test case for conversationsPushedMessagesPost * * Send an automated message to a visitor. * */ public function testConversationsPushedMessagesPost() { } } brevo-php/test/Api/TransactionalEmailsApiTest.php 0000644 00000014216 15021222673 0016102 0 ustar 00 <?php /** * TransactionalEmailsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * TransactionalEmailsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TransactionalEmailsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for blockNewDomain * * Add a new domain to the list of blocked domains. * */ public function testBlockNewDomain() { } /** * Test case for createSmtpTemplate * * Create an email template. * */ public function testCreateSmtpTemplate() { } /** * Test case for deleteBlockedDomain * * Unblock an existing domain from the list of blocked domains. * */ public function testDeleteBlockedDomain() { } /** * Test case for deleteHardbounces * * Delete hardbounces. * */ public function testDeleteHardbounces() { } /** * Test case for deleteScheduledEmailById * * Delete scheduled emails by batchId or messageId. * */ public function testDeleteScheduledEmailById() { } /** * Test case for deleteSmtpTemplate * * Delete an inactive email template. * */ public function testDeleteSmtpTemplate() { } /** * Test case for getAggregatedSmtpReport * * Get your transactional email activity aggregated over a period of time. * */ public function testGetAggregatedSmtpReport() { } /** * Test case for getBlockedDomains * * Get the list of blocked domains. * */ public function testGetBlockedDomains() { } /** * Test case for getEmailEventReport * * Get all your transactional email activity (unaggregated events). * */ public function testGetEmailEventReport() { } /** * Test case for getScheduledEmailByBatchId * * Fetch scheduled emails by batchId. * */ public function testGetScheduledEmailByBatchId() { } /** * Test case for getScheduledEmailByMessageId * * Fetch scheduled email by messageId. * */ public function testGetScheduledEmailByMessageId() { } /** * Test case for getSmtpReport * * Get your transactional email activity aggregated per day. * */ public function testGetSmtpReport() { } /** * Test case for getSmtpTemplate * * Returns the template information. * */ public function testGetSmtpTemplate() { } /** * Test case for getSmtpTemplates * * Get the list of email templates. * */ public function testGetSmtpTemplates() { } /** * Test case for getTransacBlockedContacts * * Get the list of blocked or unsubscribed transactional contacts. * */ public function testGetTransacBlockedContacts() { } /** * Test case for getTransacEmailContent * * Get the personalized content of a sent transactional email. * */ public function testGetTransacEmailContent() { } /** * Test case for getTransacEmailsList * * Get the list of transactional emails on the basis of allowed filters. * */ public function testGetTransacEmailsList() { } /** * Test case for sendTestTemplate * * Send a template to your test list. * */ public function testSendTestTemplate() { } /** * Test case for sendTransacEmail * * Send a transactional email. * */ public function testSendTransacEmail() { } /** * Test case for smtpBlockedContactsEmailDelete * * Unblock or resubscribe a transactional contact. * */ public function testSmtpBlockedContactsEmailDelete() { } /** * Test case for smtpLogMessageIdDelete * * Delete an SMTP transactional log. * */ public function testSmtpLogMessageIdDelete() { } /** * Test case for updateSmtpTemplate * * Update an email template. * */ public function testUpdateSmtpTemplate() { } } brevo-php/test/Api/AccountApiTest.php 0000644 00000005003 15021222673 0013533 0 ustar 00 <?php /** * AccountApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * AccountApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AccountApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for getAccount * * Get your account information, plan and credits details. * */ public function testGetAccount() { } /** * Test case for getAccountActivity * * Get user activity logs. * */ public function testGetAccountActivity() { } } brevo-php/test/Api/ContactsApiTest.php 0000644 00000014636 15021222673 0013731 0 ustar 00 <?php /** * ContactsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * ContactsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ContactsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for addContactToList * * Add existing contacts to a list. * */ public function testAddContactToList() { } /** * Test case for createAttribute * * Create contact attribute. * */ public function testCreateAttribute() { } /** * Test case for createContact * * Create a contact. * */ public function testCreateContact() { } /** * Test case for createDoiContact * * Create Contact via DOI (Double-Opt-In) Flow. * */ public function testCreateDoiContact() { } /** * Test case for createFolder * * Create a folder. * */ public function testCreateFolder() { } /** * Test case for createList * * Create a list. * */ public function testCreateList() { } /** * Test case for deleteAttribute * * Delete an attribute. * */ public function testDeleteAttribute() { } /** * Test case for deleteContact * * Delete a contact. * */ public function testDeleteContact() { } /** * Test case for deleteFolder * * Delete a folder (and all its lists). * */ public function testDeleteFolder() { } /** * Test case for deleteList * * Delete a list. * */ public function testDeleteList() { } /** * Test case for getAttributes * * List all attributes. * */ public function testGetAttributes() { } /** * Test case for getContactInfo * * Get a contact's details. * */ public function testGetContactInfo() { } /** * Test case for getContactStats * * Get email campaigns' statistics for a contact. * */ public function testGetContactStats() { } /** * Test case for getContacts * * Get all the contacts. * */ public function testGetContacts() { } /** * Test case for getContactsFromList * * Get contacts in a list. * */ public function testGetContactsFromList() { } /** * Test case for getFolder * * Returns a folder's details. * */ public function testGetFolder() { } /** * Test case for getFolderLists * * Get lists in a folder. * */ public function testGetFolderLists() { } /** * Test case for getFolders * * Get all folders. * */ public function testGetFolders() { } /** * Test case for getList * * Get a list's details. * */ public function testGetList() { } /** * Test case for getLists * * Get all the lists. * */ public function testGetLists() { } /** * Test case for getSegments * * Get all the Segments. * */ public function testGetSegments() { } /** * Test case for importContacts * * Import contacts. * */ public function testImportContacts() { } /** * Test case for removeContactFromList * * Delete a contact from a list. * */ public function testRemoveContactFromList() { } /** * Test case for requestContactExport * * Export contacts. * */ public function testRequestContactExport() { } /** * Test case for updateAttribute * * Update contact attribute. * */ public function testUpdateAttribute() { } /** * Test case for updateBatchContacts * * Update multiple contacts. * */ public function testUpdateBatchContacts() { } /** * Test case for updateContact * * Update a contact. * */ public function testUpdateContact() { } /** * Test case for updateFolder * * Update a folder. * */ public function testUpdateFolder() { } /** * Test case for updateList * * Update a list. * */ public function testUpdateList() { } } brevo-php/test/Api/WhatsAppCampaignsApiTest.php 0000644 00000007416 15021222673 0015523 0 ustar 00 <?php /** * WhatsAppCampaignsApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * WhatsAppCampaignsApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsAppCampaignsApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createWhatsAppCampaign * * Create and Send a WhatsApp campaign. * */ public function testCreateWhatsAppCampaign() { } /** * Test case for createWhatsAppTemplate * * Create a WhatsApp template. * */ public function testCreateWhatsAppTemplate() { } /** * Test case for deleteWhatsAppCampaign * * Delete a WhatsApp campaign. * */ public function testDeleteWhatsAppCampaign() { } /** * Test case for getWhatsAppCampaign * * Get a WhatsApp campaign. * */ public function testGetWhatsAppCampaign() { } /** * Test case for getWhatsAppCampaigns * * Return all your created WhatsApp campaigns. * */ public function testGetWhatsAppCampaigns() { } /** * Test case for getWhatsAppConfig * * Get your WhatsApp API account information. * */ public function testGetWhatsAppConfig() { } /** * Test case for getWhatsAppTemplates * * Return all your created WhatsApp templates. * */ public function testGetWhatsAppTemplates() { } /** * Test case for sendWhatsAppTemplateApproval * * Send your WhatsApp template for approval. * */ public function testSendWhatsAppTemplateApproval() { } /** * Test case for updateWhatsAppCampaign * * Update a WhatsApp campaign. * */ public function testUpdateWhatsAppCampaign() { } } brevo-php/test/Api/EcommerceApiTest.php 0000644 00000007636 15021222673 0014054 0 ustar 00 <?php /** * EcommerceApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * EcommerceApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EcommerceApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createBatchOrder * * Create orders in batch. * */ public function testCreateBatchOrder() { } /** * Test case for createOrder * * Managing the status of the order. * */ public function testCreateOrder() { } /** * Test case for createUpdateBatchCategory * * Create categories in batch. * */ public function testCreateUpdateBatchCategory() { } /** * Test case for createUpdateBatchProducts * * Create products in batch. * */ public function testCreateUpdateBatchProducts() { } /** * Test case for createUpdateCategory * * Create/Update a category. * */ public function testCreateUpdateCategory() { } /** * Test case for createUpdateProduct * * Create/Update a product. * */ public function testCreateUpdateProduct() { } /** * Test case for ecommerceActivatePost * * Activate the eCommerce app. * */ public function testEcommerceActivatePost() { } /** * Test case for getCategories * * Return all your categories. * */ public function testGetCategories() { } /** * Test case for getCategoryInfo * * Get a category details. * */ public function testGetCategoryInfo() { } /** * Test case for getProductInfo * * Get a product's details. * */ public function testGetProductInfo() { } /** * Test case for getProducts * * Return all your products. * */ public function testGetProducts() { } } brevo-php/test/Api/AttributesApiTest.php 0000644 00000005434 15021222673 0014275 0 ustar 00 <?php /** * AttributesApiTest * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the endpoint. */ namespace Brevo\Client; use \Brevo\Client\Configuration; use \Brevo\Client\ApiException; use \Brevo\Client\ObjectSerializer; /** * AttributesApiTest Class Doc Comment * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AttributesApiTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test cases */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test case for createAttribute * * Create contact attribute. * */ public function testCreateAttribute() { } /** * Test case for deleteAttribute * * Delete an attribute. * */ public function testDeleteAttribute() { } /** * Test case for getAttributes * * List all attributes. * */ public function testGetAttributes() { } /** * Test case for updateAttribute * * Update contact attribute. * */ public function testUpdateAttribute() { } } brevo-php/test/Model/WhatsappCampTemplateTest.php 0000644 00000006705 15021222673 0016132 0 ustar 00 <?php /** * WhatsappCampTemplateTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * WhatsappCampTemplateTest Class Doc Comment * * @category Class * @description WhatsappCampTemplate * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsappCampTemplateTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "WhatsappCampTemplate" */ public function testWhatsappCampTemplate() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "category" */ public function testPropertyCategory() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } /** * Test attribute "containsButton" */ public function testPropertyContainsButton() { } /** * Test attribute "displayHeader" */ public function testPropertyDisplayHeader() { } /** * Test attribute "headerType" */ public function testPropertyHeaderType() { } /** * Test attribute "components" */ public function testPropertyComponents() { } /** * Test attribute "headerVariables" */ public function testPropertyHeaderVariables() { } /** * Test attribute "bodyVariables" */ public function testPropertyBodyVariables() { } /** * Test attribute "buttonType" */ public function testPropertyButtonType() { } /** * Test attribute "hideFooter" */ public function testPropertyHideFooter() { } } brevo-php/test/Model/Body12Test.php 0000644 00000005150 15021222673 0013077 0 ustar 00 <?php /** * Body12Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body12Test Class Doc Comment * * @category Class * @description Body12 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body12Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body12" */ public function testBody12() { } /** * Test attribute "agentId" */ public function testPropertyAgentId() { } /** * Test attribute "receivedFrom" */ public function testPropertyReceivedFrom() { } /** * Test attribute "agentEmail" */ public function testPropertyAgentEmail() { } /** * Test attribute "agentName" */ public function testPropertyAgentName() { } } brevo-php/test/Model/Body6Test.php 0000644 00000006455 15021222673 0013033 0 ustar 00 <?php /** * Body6Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body6Test Class Doc Comment * * @category Class * @description Body6 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body6Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body6" */ public function testBody6() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "duration" */ public function testPropertyDuration() { } /** * Test attribute "taskTypeId" */ public function testPropertyTaskTypeId() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "notes" */ public function testPropertyNotes() { } /** * Test attribute "done" */ public function testPropertyDone() { } /** * Test attribute "assignToId" */ public function testPropertyAssignToId() { } /** * Test attribute "contactsIds" */ public function testPropertyContactsIds() { } /** * Test attribute "dealsIds" */ public function testPropertyDealsIds() { } /** * Test attribute "companiesIds" */ public function testPropertyCompaniesIds() { } /** * Test attribute "reminder" */ public function testPropertyReminder() { } } brevo-php/test/Model/GetChildInfoApiKeysTest.php 0000644 00000004721 15021222673 0015627 0 ustar 00 <?php /** * GetChildInfoApiKeysTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoApiKeysTest Class Doc Comment * * @category Class * @description API Keys associated to child account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeysTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfoApiKeys" */ public function testGetChildInfoApiKeys() { } /** * Test attribute "v2" */ public function testPropertyV2() { } /** * Test attribute "v3" */ public function testPropertyV3() { } } brevo-php/test/Model/CreateEmailCampaignTest.php 0000644 00000013075 15021222673 0015657 0 ustar 00 <?php /** * CreateEmailCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateEmailCampaignTest Class Doc Comment * * @category Class * @description CreateEmailCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateEmailCampaign" */ public function testCreateEmailCampaign() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "htmlUrl" */ public function testPropertyHtmlUrl() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "previewText" */ public function testPropertyPreviewText() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "attachmentUrl" */ public function testPropertyAttachmentUrl() { } /** * Test attribute "inlineImageActivation" */ public function testPropertyInlineImageActivation() { } /** * Test attribute "mirrorActive" */ public function testPropertyMirrorActive() { } /** * Test attribute "footer" */ public function testPropertyFooter() { } /** * Test attribute "header" */ public function testPropertyHeader() { } /** * Test attribute "utmCampaign" */ public function testPropertyUtmCampaign() { } /** * Test attribute "params" */ public function testPropertyParams() { } /** * Test attribute "sendAtBestTime" */ public function testPropertySendAtBestTime() { } /** * Test attribute "abTesting" */ public function testPropertyAbTesting() { } /** * Test attribute "subjectA" */ public function testPropertySubjectA() { } /** * Test attribute "subjectB" */ public function testPropertySubjectB() { } /** * Test attribute "splitRule" */ public function testPropertySplitRule() { } /** * Test attribute "winnerCriteria" */ public function testPropertyWinnerCriteria() { } /** * Test attribute "winnerDelay" */ public function testPropertyWinnerDelay() { } /** * Test attribute "ipWarmupEnable" */ public function testPropertyIpWarmupEnable() { } /** * Test attribute "initialQuota" */ public function testPropertyInitialQuota() { } /** * Test attribute "increaseRate" */ public function testPropertyIncreaseRate() { } /** * Test attribute "unsubscriptionPageId" */ public function testPropertyUnsubscriptionPageId() { } /** * Test attribute "updateFormId" */ public function testPropertyUpdateFormId() { } } brevo-php/test/Model/CreateApiKeyRequestTest.php 0000644 00000004704 15021222673 0015722 0 ustar 00 <?php /** * CreateApiKeyRequestTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateApiKeyRequestTest Class Doc Comment * * @category Class * @description CreateApiKeyRequest * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateApiKeyRequestTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateApiKeyRequest" */ public function testCreateApiKeyRequest() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetListsTest.php 0000644 00000004612 15021222673 0013577 0 ustar 00 <?php /** * GetListsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetListsTest Class Doc Comment * * @category Class * @description GetLists * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetListsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetLists" */ public function testGetLists() { } /** * Test attribute "lists" */ public function testPropertyLists() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetInvitedUsersListFeatureAccessTest.php 0000644 00000005230 15021222673 0020414 0 ustar 00 <?php /** * GetInvitedUsersListFeatureAccessTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInvitedUsersListFeatureAccessTest Class Doc Comment * * @category Class * @description Feature accessiblity given to the user. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersListFeatureAccessTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInvitedUsersListFeatureAccess" */ public function testGetInvitedUsersListFeatureAccess() { } /** * Test attribute "marketing" */ public function testPropertyMarketing() { } /** * Test attribute "conversations" */ public function testPropertyConversations() { } /** * Test attribute "crm" */ public function testPropertyCrm() { } } brevo-php/test/Model/DealAttributesInnerTest.php 0000644 00000005472 15021222673 0015756 0 ustar 00 <?php /** * DealAttributesInnerTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * DealAttributesInnerTest Class Doc Comment * * @category Class * @description List of attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealAttributesInnerTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "DealAttributesInner" */ public function testDealAttributesInner() { } /** * Test attribute "internalName" */ public function testPropertyInternalName() { } /** * Test attribute "label" */ public function testPropertyLabel() { } /** * Test attribute "attributeTypeName" */ public function testPropertyAttributeTypeName() { } /** * Test attribute "attributeOptions" */ public function testPropertyAttributeOptions() { } /** * Test attribute "isRequired" */ public function testPropertyIsRequired() { } } brevo-php/test/Model/RemainingCreditModelTest.php 0000644 00000004730 15021222673 0016067 0 ustar 00 <?php /** * RemainingCreditModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RemainingCreditModelTest Class Doc Comment * * @category Class * @description RemainingCreditModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RemainingCreditModel" */ public function testRemainingCreditModel() { } /** * Test attribute "child" */ public function testPropertyChild() { } /** * Test attribute "reseller" */ public function testPropertyReseller() { } } brevo-php/test/Model/AbTestCampaignResultStatisticsTest.php 0000644 00000005720 15021222673 0020136 0 ustar 00 <?php /** * AbTestCampaignResultStatisticsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestCampaignResultStatisticsTest Class Doc Comment * * @category Class * @description AbTestCampaignResultStatistics * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResultStatisticsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestCampaignResultStatistics" */ public function testAbTestCampaignResultStatistics() { } /** * Test attribute "openers" */ public function testPropertyOpeners() { } /** * Test attribute "clicks" */ public function testPropertyClicks() { } /** * Test attribute "unsubscribed" */ public function testPropertyUnsubscribed() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "complaints" */ public function testPropertyComplaints() { } } brevo-php/test/Model/GetChildDomainsTest.php 0000644 00000004356 15021222673 0015044 0 ustar 00 <?php /** * GetChildDomainsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildDomainsTest Class Doc Comment * * @category Class * @description GetChildDomains * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildDomainsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildDomains" */ public function testGetChildDomains() { } } brevo-php/test/Model/CreatedBatchIdTest.php 0000644 00000004517 15021222673 0014633 0 ustar 00 <?php /** * CreatedBatchIdTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreatedBatchIdTest Class Doc Comment * * @category Class * @description CreatedBatchId * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreatedBatchIdTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreatedBatchId" */ public function testCreatedBatchId() { } /** * Test attribute "batchId" */ public function testPropertyBatchId() { } } brevo-php/test/Model/CreateChildTest.php 0000644 00000005516 15021222673 0014214 0 ustar 00 <?php /** * CreateChildTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateChildTest Class Doc Comment * * @category Class * @description CreateChild * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateChildTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateChild" */ public function testCreateChild() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "firstName" */ public function testPropertyFirstName() { } /** * Test attribute "lastName" */ public function testPropertyLastName() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } } brevo-php/test/Model/GetSsoTokenTest.php 0000644 00000004471 15021222673 0014251 0 ustar 00 <?php /** * GetSsoTokenTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSsoTokenTest Class Doc Comment * * @category Class * @description GetSsoToken * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSsoTokenTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSsoToken" */ public function testGetSsoToken() { } /** * Test attribute "token" */ public function testPropertyToken() { } } brevo-php/test/Model/UpdateSmtpTemplateSenderTest.php 0000644 00000005500 15021222673 0016761 0 ustar 00 <?php /** * UpdateSmtpTemplateSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateSmtpTemplateSenderTest Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmtpTemplateSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateSmtpTemplateSender" */ public function testUpdateSmtpTemplateSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/ConversationsMessageFIleImageInfoTest.php 0000644 00000005237 15021222673 0020526 0 ustar 00 <?php /** * ConversationsMessageFileImageInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ConversationsMessageFileImageInfoTest Class Doc Comment * * @category Class * @description image info is passed in case the file is an image * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessageFileImageInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ConversationsMessageFileImageInfo" */ public function testConversationsMessageFileImageInfo() { } /** * Test attribute "width" */ public function testPropertyWidth() { } /** * Test attribute "height" */ public function testPropertyHeight() { } /** * Test attribute "previewUrl" */ public function testPropertyPreviewUrl() { } } brevo-php/test/Model/GetFolderListsTest.php 0000644 00000004656 15021222673 0014743 0 ustar 00 <?php /** * GetFolderListsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetFolderListsTest Class Doc Comment * * @category Class * @description GetFolderLists * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFolderListsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetFolderLists" */ public function testGetFolderLists() { } /** * Test attribute "lists" */ public function testPropertyLists() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetContactCampaignStatsTransacAttributesTest.php 0000644 00000005303 15021222673 0022134 0 ustar 00 <?php /** * GetContactCampaignStatsTransacAttributesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactCampaignStatsTransacAttributesTest Class Doc Comment * * @category Class * @description GetContactCampaignStatsTransacAttributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsTransacAttributesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactCampaignStatsTransacAttributes" */ public function testGetContactCampaignStatsTransacAttributes() { } /** * Test attribute "orderDate" */ public function testPropertyOrderDate() { } /** * Test attribute "orderPrice" */ public function testPropertyOrderPrice() { } /** * Test attribute "orderId" */ public function testPropertyOrderId() { } } brevo-php/test/Model/UpdateCampaignStatusTest.php 0000644 00000004563 15021222673 0016134 0 ustar 00 <?php /** * UpdateCampaignStatusTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateCampaignStatusTest Class Doc Comment * * @category Class * @description Status of the campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateCampaignStatusTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateCampaignStatus" */ public function testUpdateCampaignStatus() { } /** * Test attribute "status" */ public function testPropertyStatus() { } } brevo-php/test/Model/RemoveCreditsTest.php 0000644 00000004644 15021222673 0014621 0 ustar 00 <?php /** * RemoveCreditsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RemoveCreditsTest Class Doc Comment * * @category Class * @description RemoveCredits * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemoveCreditsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RemoveCredits" */ public function testRemoveCredits() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/GetAccountPlanTest.php 0000644 00000005534 15021222673 0014714 0 ustar 00 <?php /** * GetAccountPlanTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountPlanTest Class Doc Comment * * @category Class * @description GetAccountPlan * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountPlanTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountPlan" */ public function testGetAccountPlan() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "creditsType" */ public function testPropertyCreditsType() { } /** * Test attribute "credits" */ public function testPropertyCredits() { } /** * Test attribute "startDate" */ public function testPropertyStartDate() { } /** * Test attribute "endDate" */ public function testPropertyEndDate() { } /** * Test attribute "userLimit" */ public function testPropertyUserLimit() { } } brevo-php/test/Model/NoteDataTest.php 0000644 00000005163 15021222673 0013542 0 ustar 00 <?php /** * NoteDataTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * NoteDataTest Class Doc Comment * * @category Class * @description Note data to be saved * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteDataTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "NoteData" */ public function testNoteData() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "contactIds" */ public function testPropertyContactIds() { } /** * Test attribute "dealIds" */ public function testPropertyDealIds() { } /** * Test attribute "companyIds" */ public function testPropertyCompanyIds() { } } brevo-php/test/Model/CreateWhatsAppCampaignTest.php 0000644 00000005302 15021222673 0016351 0 ustar 00 <?php /** * CreateWhatsAppCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateWhatsAppCampaignTest Class Doc Comment * * @category Class * @description CreateWhatsAppCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateWhatsAppCampaign" */ public function testCreateWhatsAppCampaign() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } } brevo-php/test/Model/CreateSmsCampaignRecipientsTest.php 0000644 00000005026 15021222673 0017415 0 ustar 00 <?php /** * CreateSmsCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSmsCampaignRecipientsTest Class Doc Comment * * @category Class * @description CreateSmsCampaignRecipients * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmsCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSmsCampaignRecipients" */ public function testCreateSmsCampaignRecipients() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "exclusionListIds" */ public function testPropertyExclusionListIds() { } } brevo-php/test/Model/GetInvitedUsersListUsersTest.php 0000644 00000005306 15021222673 0017004 0 ustar 00 <?php /** * GetInvitedUsersListUsersTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInvitedUsersListUsersTest Class Doc Comment * * @category Class * @description GetInvitedUsersListUsers * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersListUsersTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInvitedUsersListUsers" */ public function testGetInvitedUsersListUsers() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "isOwner" */ public function testPropertyIsOwner() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "featureAccess" */ public function testPropertyFeatureAccess() { } } brevo-php/test/Model/CreateContactTest.php 0000644 00000006134 15021222673 0014561 0 ustar 00 <?php /** * CreateContactTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateContactTest Class Doc Comment * * @category Class * @description CreateContact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateContactTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateContact" */ public function testCreateContact() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "extId" */ public function testPropertyExtId() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "emailBlacklisted" */ public function testPropertyEmailBlacklisted() { } /** * Test attribute "smsBlacklisted" */ public function testPropertySmsBlacklisted() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "updateEnabled" */ public function testPropertyUpdateEnabled() { } /** * Test attribute "smtpBlacklistSender" */ public function testPropertySmtpBlacklistSender() { } } brevo-php/test/Model/GetWhatsappEventReportTest.php 0000644 00000004575 15021222673 0016476 0 ustar 00 <?php /** * GetWhatsappEventReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsappEventReportTest Class Doc Comment * * @category Class * @description GetWhatsappEventReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappEventReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsappEventReport" */ public function testGetWhatsappEventReport() { } /** * Test attribute "events" */ public function testPropertyEvents() { } } brevo-php/test/Model/GetWhatsappEventReportEventsTest.php 0000644 00000006176 15021222673 0017662 0 ustar 00 <?php /** * GetWhatsappEventReportEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsappEventReportEventsTest Class Doc Comment * * @category Class * @description GetWhatsappEventReportEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappEventReportEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsappEventReportEvents" */ public function testGetWhatsappEventReportEvents() { } /** * Test attribute "contactNumber" */ public function testPropertyContactNumber() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "event" */ public function testPropertyEvent() { } /** * Test attribute "reason" */ public function testPropertyReason() { } /** * Test attribute "body" */ public function testPropertyBody() { } /** * Test attribute "mediaUrl" */ public function testPropertyMediaUrl() { } /** * Test attribute "senderNumber" */ public function testPropertySenderNumber() { } } brevo-php/test/Model/VariablesItemsTest.php 0000644 00000005031 15021222673 0014747 0 ustar 00 <?php /** * VariablesItemsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * VariablesItemsTest Class Doc Comment * * @category Class * @description VariablesItems * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class VariablesItemsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "VariablesItems" */ public function testVariablesItems() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "default" */ public function testPropertyDefault() { } /** * Test attribute "datatype" */ public function testPropertyDatatype() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoFeaturesInboxTest.php 0000644 00000005133 15021222673 0023261 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesInboxTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoFeaturesInboxTest Class Doc Comment * * @category Class * @description Inbox details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesInboxTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoFeaturesInbox" */ public function testSubAccountDetailsResponsePlanInfoFeaturesInbox() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } } brevo-php/test/Model/SubAccountDetailsResponseTest.php 0000644 00000005306 15021222673 0017135 0 ustar 00 <?php /** * SubAccountDetailsResponseTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponseTest Class Doc Comment * * @category Class * @description SubAccountDetailsResponse * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponseTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponse" */ public function testSubAccountDetailsResponse() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "planInfo" */ public function testPropertyPlanInfo() { } } brevo-php/test/Model/RequestContactExportCustomContactFilterTest.php 0000644 00000006132 15021222673 0022063 0 ustar 00 <?php /** * RequestContactExportCustomContactFilterTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestContactExportCustomContactFilterTest Class Doc Comment * * @category Class * @description Set the filter for the contacts to be exported. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactExportCustomContactFilterTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestContactExportCustomContactFilter" */ public function testRequestContactExportCustomContactFilter() { } /** * Test attribute "actionForContacts" */ public function testPropertyActionForContacts() { } /** * Test attribute "actionForEmailCampaigns" */ public function testPropertyActionForEmailCampaigns() { } /** * Test attribute "actionForSmsCampaigns" */ public function testPropertyActionForSmsCampaigns() { } /** * Test attribute "listId" */ public function testPropertyListId() { } /** * Test attribute "emailCampaignId" */ public function testPropertyEmailCampaignId() { } /** * Test attribute "smsCampaignId" */ public function testPropertySmsCampaignId() { } } brevo-php/test/Model/GetAttributesEnumerationTest.php 0000644 00000004752 15021222673 0017043 0 ustar 00 <?php /** * GetAttributesEnumerationTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAttributesEnumerationTest Class Doc Comment * * @category Class * @description GetAttributesEnumeration * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributesEnumerationTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAttributesEnumeration" */ public function testGetAttributesEnumeration() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "label" */ public function testPropertyLabel() { } } brevo-php/test/Model/CreateResellerTest.php 0000644 00000004654 15021222673 0014750 0 ustar 00 <?php /** * CreateResellerTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateResellerTest Class Doc Comment * * @category Class * @description CreateReseller * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateResellerTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateReseller" */ public function testCreateReseller() { } /** * Test attribute "authKey" */ public function testPropertyAuthKey() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/AbTestCampaignResultClickedLinksTest.php 0000644 00000005046 15021222673 0020344 0 ustar 00 <?php /** * AbTestCampaignResultClickedLinksTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestCampaignResultClickedLinksTest Class Doc Comment * * @category Class * @description AbTestCampaignResultClickedLinks * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResultClickedLinksTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestCampaignResultClickedLinks" */ public function testAbTestCampaignResultClickedLinks() { } /** * Test attribute "versionA" */ public function testPropertyVersionA() { } /** * Test attribute "versionB" */ public function testPropertyVersionB() { } } brevo-php/test/Model/CreateDoiContactTest.php 0000644 00000005620 15021222673 0015214 0 ustar 00 <?php /** * CreateDoiContactTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateDoiContactTest Class Doc Comment * * @category Class * @description CreateDoiContact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDoiContactTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateDoiContact" */ public function testCreateDoiContact() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "includeListIds" */ public function testPropertyIncludeListIds() { } /** * Test attribute "excludeListIds" */ public function testPropertyExcludeListIds() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "redirectionUrl" */ public function testPropertyRedirectionUrl() { } } brevo-php/test/Model/GetScheduledEmailByBatchIdBatchesTest.php 0000644 00000005231 15021222673 0020353 0 ustar 00 <?php /** * GetScheduledEmailByBatchIdBatchesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetScheduledEmailByBatchIdBatchesTest Class Doc Comment * * @category Class * @description GetScheduledEmailByBatchIdBatches * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByBatchIdBatchesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetScheduledEmailByBatchIdBatches" */ public function testGetScheduledEmailByBatchIdBatches() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "status" */ public function testPropertyStatus() { } } brevo-php/test/Model/GetChildInfoApiKeysV2Test.php 0000644 00000004722 15021222673 0016040 0 ustar 00 <?php /** * GetChildInfoApiKeysV2Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoApiKeysV2Test Class Doc Comment * * @category Class * @description GetChildInfoApiKeysV2 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeysV2Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfoApiKeysV2" */ public function testGetChildInfoApiKeysV2() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "key" */ public function testPropertyKey() { } } brevo-php/test/Model/GetUserPermissionTest.php 0000644 00000005063 15021222673 0015471 0 ustar 00 <?php /** * GetUserPermissionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetUserPermissionTest Class Doc Comment * * @category Class * @description Check user permission * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetUserPermissionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetUserPermission" */ public function testGetUserPermission() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "privileges" */ public function testPropertyPrivileges() { } } brevo-php/test/Model/NoteTest.php 0000644 00000005605 15021222673 0012751 0 ustar 00 <?php /** * NoteTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * NoteTest Class Doc Comment * * @category Class * @description Note Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Note" */ public function testNote() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "contactIds" */ public function testPropertyContactIds() { } /** * Test attribute "dealIds" */ public function testPropertyDealIds() { } /** * Test attribute "authorId" */ public function testPropertyAuthorId() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "updatedAt" */ public function testPropertyUpdatedAt() { } } brevo-php/test/Model/GetWhatsappCampaignOverviewTest.php 0000644 00000006375 15021222673 0017467 0 ustar 00 <?php /** * GetWhatsappCampaignOverviewTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsappCampaignOverviewTest Class Doc Comment * * @category Class * @description GetWhatsappCampaignOverview * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaignOverviewTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsappCampaignOverview" */ public function testGetWhatsappCampaignOverview() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "campaignName" */ public function testPropertyCampaignName() { } /** * Test attribute "campaignStatus" */ public function testPropertyCampaignStatus() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "senderNumber" */ public function testPropertySenderNumber() { } /** * Test attribute "stats" */ public function testPropertyStats() { } /** * Test attribute "template" */ public function testPropertyTemplate() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/GetContactsTest.php 0000644 00000004642 15021222673 0014262 0 ustar 00 <?php /** * GetContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactsTest Class Doc Comment * * @category Class * @description GetContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContacts" */ public function testGetContacts() { } /** * Test attribute "contacts" */ public function testPropertyContacts() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetContactCampaignStatsUnsubscriptionsTest.php 0000644 00000005164 15021222673 0021711 0 ustar 00 <?php /** * GetContactCampaignStatsUnsubscriptionsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactCampaignStatsUnsubscriptionsTest Class Doc Comment * * @category Class * @description GetContactCampaignStatsUnsubscriptions * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsUnsubscriptionsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactCampaignStatsUnsubscriptions" */ public function testGetContactCampaignStatsUnsubscriptions() { } /** * Test attribute "userUnsubscription" */ public function testPropertyUserUnsubscription() { } /** * Test attribute "adminUnsubscription" */ public function testPropertyAdminUnsubscription() { } } brevo-php/test/Model/SendSmtpEmailSenderTest.php 0000644 00000005544 15021222673 0015714 0 ustar 00 <?php /** * SendSmtpEmailSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailSenderTest Class Doc Comment * * @category Class * @description Mandatory if `templateId` is not passed. Pass `name` (optional) and `email` OR `id` of sender from which emails will be sent. `name` will be ignored if passed along with sender `id`. For example, {\"name\":\"Mary from MyShop\", \"email\":\"no-reply@myshop.com\"} or {\"id\":2} * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailSender" */ public function testSendSmtpEmailSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/GetWhatsappCampaignsTest.php 0000644 00000004732 15021222673 0016116 0 ustar 00 <?php /** * GetWhatsappCampaignsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsappCampaignsTest Class Doc Comment * * @category Class * @description GetWhatsappCampaigns * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaignsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsappCampaigns" */ public function testGetWhatsappCampaigns() { } /** * Test attribute "campaigns" */ public function testPropertyCampaigns() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetSendersListIpsTest.php 0000644 00000005041 15021222673 0015411 0 ustar 00 <?php /** * GetSendersListIpsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSendersListIpsTest Class Doc Comment * * @category Class * @description GetSendersListIps * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersListIpsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSendersListIps" */ public function testGetSendersListIps() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } /** * Test attribute "weight" */ public function testPropertyWeight() { } } brevo-php/test/Model/CreateSenderTest.php 0000644 00000004777 15021222673 0014421 0 ustar 00 <?php /** * CreateSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSenderTest Class Doc Comment * * @category Class * @description CreateSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSender" */ public function testCreateSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "ips" */ public function testPropertyIps() { } } brevo-php/test/Model/GetChildInfoStatisticsTest.php 0000644 00000005241 15021222673 0016412 0 ustar 00 <?php /** * GetChildInfoStatisticsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoStatisticsTest Class Doc Comment * * @category Class * @description Statistics about your child account activity * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoStatisticsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfoStatistics" */ public function testGetChildInfoStatistics() { } /** * Test attribute "previousMonthTotalSent" */ public function testPropertyPreviousMonthTotalSent() { } /** * Test attribute "currentMonthTotalSent" */ public function testPropertyCurrentMonthTotalSent() { } /** * Test attribute "totalSent" */ public function testPropertyTotalSent() { } } brevo-php/test/Model/GetFolderTest.php 0000644 00000005365 15021222673 0013722 0 ustar 00 <?php /** * GetFolderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetFolderTest Class Doc Comment * * @category Class * @description GetFolder * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFolderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetFolder" */ public function testGetFolder() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "totalBlacklisted" */ public function testPropertyTotalBlacklisted() { } /** * Test attribute "totalSubscribers" */ public function testPropertyTotalSubscribers() { } /** * Test attribute "uniqueSubscribers" */ public function testPropertyUniqueSubscribers() { } } brevo-php/test/Model/PostSendFailedTest.php 0000644 00000005437 15021222673 0014713 0 ustar 00 <?php /** * PostSendFailedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PostSendFailedTest Class Doc Comment * * @category Class * @description PostSendFailed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostSendFailedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "PostSendFailed" */ public function testPostSendFailed() { } /** * Test attribute "code" */ public function testPropertyCode() { } /** * Test attribute "message" */ public function testPropertyMessage() { } /** * Test attribute "unexistingEmails" */ public function testPropertyUnexistingEmails() { } /** * Test attribute "withoutListEmails" */ public function testPropertyWithoutListEmails() { } /** * Test attribute "blackListedEmails" */ public function testPropertyBlackListedEmails() { } } brevo-php/test/Model/SubAccountUpdatePlanRequestFeaturesTest.php 0000644 00000005222 15021222673 0021133 0 ustar 00 <?php /** * SubAccountUpdatePlanRequestFeaturesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountUpdatePlanRequestFeaturesTest Class Doc Comment * * @category Class * @description Features details to update * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequestFeaturesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountUpdatePlanRequestFeatures" */ public function testSubAccountUpdatePlanRequestFeatures() { } /** * Test attribute "users" */ public function testPropertyUsers() { } /** * Test attribute "landingPage" */ public function testPropertyLandingPage() { } /** * Test attribute "inbox" */ public function testPropertyInbox() { } } brevo-php/test/Model/GetAllExternalFeedsFeedsTest.php 0000644 00000006756 15021222673 0016645 0 ustar 00 <?php /** * GetAllExternalFeedsFeedsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAllExternalFeedsFeedsTest Class Doc Comment * * @category Class * @description GetAllExternalFeedsFeeds * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAllExternalFeedsFeedsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAllExternalFeedsFeeds" */ public function testGetAllExternalFeedsFeeds() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "authType" */ public function testPropertyAuthType() { } /** * Test attribute "username" */ public function testPropertyUsername() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "token" */ public function testPropertyToken() { } /** * Test attribute "headers" */ public function testPropertyHeaders() { } /** * Test attribute "maxRetries" */ public function testPropertyMaxRetries() { } /** * Test attribute "cache" */ public function testPropertyCache() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/GetInboundEmailEventsByUuidLogsTest.php 0000644 00000005020 15021222673 0020175 0 ustar 00 <?php /** * GetInboundEmailEventsByUuidLogsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInboundEmailEventsByUuidLogsTest Class Doc Comment * * @category Class * @description GetInboundEmailEventsByUuidLogs * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuidLogsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInboundEmailEventsByUuidLogs" */ public function testGetInboundEmailEventsByUuidLogs() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "type" */ public function testPropertyType() { } } brevo-php/test/Model/CreateSubAccountResponseTest.php 0000644 00000004601 15021222673 0016750 0 ustar 00 <?php /** * CreateSubAccountResponseTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSubAccountResponseTest Class Doc Comment * * @category Class * @description CreateSubAccountResponse * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSubAccountResponseTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSubAccountResponse" */ public function testCreateSubAccountResponse() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/SendTestSmsTest.php 0000644 00000004505 15021222673 0014256 0 ustar 00 <?php /** * SendTestSmsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendTestSmsTest Class Doc Comment * * @category Class * @description SendTestSms * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTestSmsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendTestSms" */ public function testSendTestSms() { } /** * Test attribute "phoneNumber" */ public function testPropertyPhoneNumber() { } } brevo-php/test/Model/SendSmtpEmailReplyToTest.php 0000644 00000005160 15021222673 0016064 0 ustar 00 <?php /** * SendSmtpEmailReplyToTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailReplyToTest Class Doc Comment * * @category Class * @description Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"}. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailReplyToTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailReplyTo" */ public function testSendSmtpEmailReplyTo() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetCampaignOverviewTest.php 0000644 00000007320 15021222673 0015746 0 ustar 00 <?php /** * GetCampaignOverviewTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCampaignOverviewTest Class Doc Comment * * @category Class * @description GetCampaignOverview * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignOverviewTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCampaignOverview" */ public function testGetCampaignOverview() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "previewText" */ public function testPropertyPreviewText() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "abTesting" */ public function testPropertyAbTesting() { } /** * Test attribute "subjectA" */ public function testPropertySubjectA() { } /** * Test attribute "subjectB" */ public function testPropertySubjectB() { } /** * Test attribute "splitRule" */ public function testPropertySplitRule() { } /** * Test attribute "winnerCriteria" */ public function testPropertyWinnerCriteria() { } /** * Test attribute "winnerDelay" */ public function testPropertyWinnerDelay() { } /** * Test attribute "sendAtBestTime" */ public function testPropertySendAtBestTime() { } } brevo-php/test/Model/GetReportsTest.php 0000644 00000004467 15021222673 0014147 0 ustar 00 <?php /** * GetReportsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetReportsTest Class Doc Comment * * @category Class * @description GetReports * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetReportsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetReports" */ public function testGetReports() { } /** * Test attribute "reports" */ public function testPropertyReports() { } } brevo-php/test/Model/GetAccountMarketingAutomationTest.php 0000644 00000005010 15021222673 0017771 0 ustar 00 <?php /** * GetAccountMarketingAutomationTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountMarketingAutomationTest Class Doc Comment * * @category Class * @description GetAccountMarketingAutomation * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountMarketingAutomationTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountMarketingAutomation" */ public function testGetAccountMarketingAutomation() { } /** * Test attribute "key" */ public function testPropertyKey() { } /** * Test attribute "enabled" */ public function testPropertyEnabled() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoCreditsTest.php 0000644 00000005126 15021222673 0022102 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoCreditsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoCreditsTest Class Doc Comment * * @category Class * @description Credits quota and remaining credits on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoCreditsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoCredits" */ public function testSubAccountDetailsResponsePlanInfoCredits() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "emails" */ public function testPropertyEmails() { } } brevo-php/test/Model/RemoveContactFromListTest.php 0000644 00000005065 15021222673 0016275 0 ustar 00 <?php /** * RemoveContactFromListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RemoveContactFromListTest Class Doc Comment * * @category Class * @description RemoveContactFromList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemoveContactFromListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RemoveContactFromList" */ public function testRemoveContactFromList() { } /** * Test attribute "emails" */ public function testPropertyEmails() { } /** * Test attribute "ids" */ public function testPropertyIds() { } /** * Test attribute "all" */ public function testPropertyAll() { } } brevo-php/test/Model/ConversationsMessageFileTest.php 0000644 00000005437 15021222673 0017011 0 ustar 00 <?php /** * ConversationsMessageFileTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ConversationsMessageFileTest Class Doc Comment * * @category Class * @description ConversationsMessageFile * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessageFileTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ConversationsMessageFile" */ public function testConversationsMessageFile() { } /** * Test attribute "filename" */ public function testPropertyFilename() { } /** * Test attribute "size" */ public function testPropertySize() { } /** * Test attribute "isImage" */ public function testPropertyIsImage() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "imageInfo" */ public function testPropertyImageInfo() { } } brevo-php/test/Model/GetSmsCampaignStatsTest.php 0000644 00000005775 15021222673 0015735 0 ustar 00 <?php /** * GetSmsCampaignStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsCampaignStatsTest Class Doc Comment * * @category Class * @description GetSmsCampaignStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsCampaignStats" */ public function testGetSmsCampaignStats() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "sent" */ public function testPropertySent() { } /** * Test attribute "processing" */ public function testPropertyProcessing() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "unsubscriptions" */ public function testPropertyUnsubscriptions() { } /** * Test attribute "answered" */ public function testPropertyAnswered() { } } brevo-php/test/Model/Body1Test.php 0000644 00000006455 15021222673 0013026 0 ustar 00 <?php /** * Body1Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body1Test Class Doc Comment * * @category Class * @description Body1 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body1Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body1" */ public function testBody1() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "duration" */ public function testPropertyDuration() { } /** * Test attribute "taskTypeId" */ public function testPropertyTaskTypeId() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "notes" */ public function testPropertyNotes() { } /** * Test attribute "done" */ public function testPropertyDone() { } /** * Test attribute "assignToId" */ public function testPropertyAssignToId() { } /** * Test attribute "contactsIds" */ public function testPropertyContactsIds() { } /** * Test attribute "dealsIds" */ public function testPropertyDealsIds() { } /** * Test attribute "companiesIds" */ public function testPropertyCompaniesIds() { } /** * Test attribute "reminder" */ public function testPropertyReminder() { } } brevo-php/test/Model/Body8Test.php 0000644 00000005456 15021222673 0013035 0 ustar 00 <?php /** * Body8Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body8Test Class Doc Comment * * @category Class * @description Body8 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body8Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body8" */ public function testBody8() { } /** * Test attribute "visitorId" */ public function testPropertyVisitorId() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "agentId" */ public function testPropertyAgentId() { } /** * Test attribute "receivedFrom" */ public function testPropertyReceivedFrom() { } /** * Test attribute "agentEmail" */ public function testPropertyAgentEmail() { } /** * Test attribute "agentName" */ public function testPropertyAgentName() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsTest.php 0000644 00000006512 15021222673 0021137 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsTest Class Doc Comment * * @category Class * @description Campaign statistics of the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatistics" */ public function testGetExtendedContactDetailsStatistics() { } /** * Test attribute "messagesSent" */ public function testPropertyMessagesSent() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "complaints" */ public function testPropertyComplaints() { } /** * Test attribute "unsubscriptions" */ public function testPropertyUnsubscriptions() { } /** * Test attribute "opened" */ public function testPropertyOpened() { } /** * Test attribute "clicked" */ public function testPropertyClicked() { } /** * Test attribute "transacAttributes" */ public function testPropertyTransacAttributes() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } } brevo-php/test/Model/GetSmsEventReportTest.php 0000644 00000004537 15021222673 0015447 0 ustar 00 <?php /** * GetSmsEventReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsEventReportTest Class Doc Comment * * @category Class * @description GetSmsEventReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsEventReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsEventReport" */ public function testGetSmsEventReport() { } /** * Test attribute "events" */ public function testPropertyEvents() { } } brevo-php/test/Model/GetSendersListTest.php 0000644 00000004517 15021222673 0014744 0 ustar 00 <?php /** * GetSendersListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSendersListTest Class Doc Comment * * @category Class * @description GetSendersList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSendersList" */ public function testGetSendersList() { } /** * Test attribute "senders" */ public function testPropertySenders() { } } brevo-php/test/Model/UpdateSmtpTemplateTest.php 0000644 00000006434 15021222673 0015627 0 ustar 00 <?php /** * UpdateSmtpTemplateTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateSmtpTemplateTest Class Doc Comment * * @category Class * @description UpdateSmtpTemplate * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmtpTemplateTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateSmtpTemplate" */ public function testUpdateSmtpTemplate() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "templateName" */ public function testPropertyTemplateName() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "htmlUrl" */ public function testPropertyHtmlUrl() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "attachmentUrl" */ public function testPropertyAttachmentUrl() { } /** * Test attribute "isActive" */ public function testPropertyIsActive() { } } brevo-php/test/Model/GetSharedTemplateUrlTest.php 0000644 00000004567 15021222673 0016077 0 ustar 00 <?php /** * GetSharedTemplateUrlTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSharedTemplateUrlTest Class Doc Comment * * @category Class * @description GetSharedTemplateUrl * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSharedTemplateUrlTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSharedTemplateUrl" */ public function testGetSharedTemplateUrl() { } /** * Test attribute "sharedUrl" */ public function testPropertySharedUrl() { } } brevo-php/test/Model/CreateAttributeTest.php 0000644 00000005220 15021222673 0015124 0 ustar 00 <?php /** * CreateAttributeTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateAttributeTest Class Doc Comment * * @category Class * @description CreateAttribute * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateAttributeTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateAttribute" */ public function testCreateAttribute() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "isRecurring" */ public function testPropertyIsRecurring() { } /** * Test attribute "enumeration" */ public function testPropertyEnumeration() { } /** * Test attribute "type" */ public function testPropertyType() { } } brevo-php/test/Model/GetTransacAggregatedSmsReportTest.php 0000644 00000006550 15021222673 0017731 0 ustar 00 <?php /** * GetTransacAggregatedSmsReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacAggregatedSmsReportTest Class Doc Comment * * @category Class * @description GetTransacAggregatedSmsReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacAggregatedSmsReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacAggregatedSmsReport" */ public function testGetTransacAggregatedSmsReport() { } /** * Test attribute "range" */ public function testPropertyRange() { } /** * Test attribute "requests" */ public function testPropertyRequests() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "blocked" */ public function testPropertyBlocked() { } /** * Test attribute "unsubscribed" */ public function testPropertyUnsubscribed() { } /** * Test attribute "replied" */ public function testPropertyReplied() { } /** * Test attribute "accepted" */ public function testPropertyAccepted() { } /** * Test attribute "rejected" */ public function testPropertyRejected() { } } brevo-php/test/Model/RemainingCreditModelResellerTest.php 0000644 00000004776 15021222673 0017577 0 ustar 00 <?php /** * RemainingCreditModelResellerTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RemainingCreditModelResellerTest Class Doc Comment * * @category Class * @description RemainingCreditModelReseller * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModelResellerTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RemainingCreditModelReseller" */ public function testRemainingCreditModelReseller() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/EmailExportRecipientsTest.php 0000644 00000004762 15021222673 0016326 0 ustar 00 <?php /** * EmailExportRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * EmailExportRecipientsTest Class Doc Comment * * @category Class * @description EmailExportRecipients * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class EmailExportRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "EmailExportRecipients" */ public function testEmailExportRecipients() { } /** * Test attribute "notifyURL" */ public function testPropertyNotifyURL() { } /** * Test attribute "recipientsType" */ public function testPropertyRecipientsType() { } } brevo-php/test/Model/OtpTest.php 0000644 00000004407 15021222673 0012605 0 ustar 00 <?php /** * OtpTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * OtpTest Class Doc Comment * * @category Class * @description Otp * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OtpTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Otp" */ public function testOtp() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/OrderProductsTest.php 0000644 00000005234 15021222673 0014641 0 ustar 00 <?php /** * OrderProductsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * OrderProductsTest Class Doc Comment * * @category Class * @description Details for the Products in an order. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderProductsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "OrderProducts" */ public function testOrderProducts() { } /** * Test attribute "productId" */ public function testPropertyProductId() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "variantId" */ public function testPropertyVariantId() { } /** * Test attribute "price" */ public function testPropertyPrice() { } } brevo-php/test/Model/CreateCouponsTest.php 0000644 00000004672 15021222673 0014621 0 ustar 00 <?php /** * CreateCouponsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateCouponsTest Class Doc Comment * * @category Class * @description CreateCoupons * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCouponsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateCoupons" */ public function testCreateCoupons() { } /** * Test attribute "collectionId" */ public function testPropertyCollectionId() { } /** * Test attribute "coupons" */ public function testPropertyCoupons() { } } brevo-php/test/Model/GetTransacBlockedContactsContactsTest.php 0000644 00000005374 15021222673 0020564 0 ustar 00 <?php /** * GetTransacBlockedContactsContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacBlockedContactsContactsTest Class Doc Comment * * @category Class * @description GetTransacBlockedContactsContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContactsContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacBlockedContactsContacts" */ public function testGetTransacBlockedContactsContacts() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "senderEmail" */ public function testPropertySenderEmail() { } /** * Test attribute "reason" */ public function testPropertyReason() { } /** * Test attribute "blockedAt" */ public function testPropertyBlockedAt() { } } brevo-php/test/Model/PipelineTest.php 0000644 00000005011 15021222673 0013600 0 ustar 00 <?php /** * PipelineTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PipelineTest Class Doc Comment * * @category Class * @description List of stages * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PipelineTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Pipeline" */ public function testPipeline() { } /** * Test attribute "pipeline" */ public function testPropertyPipeline() { } /** * Test attribute "pipelineName" */ public function testPropertyPipelineName() { } /** * Test attribute "stages" */ public function testPropertyStages() { } } brevo-php/test/Model/TaskListTest.php 0000644 00000004454 15021222673 0013603 0 ustar 00 <?php /** * TaskListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * TaskListTest Class Doc Comment * * @category Class * @description List of tasks * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "TaskList" */ public function testTaskList() { } /** * Test attribute "items" */ public function testPropertyItems() { } } brevo-php/test/Model/MasterDetailsResponsePlanInfoFeaturesTest.php 0000644 00000005563 15021222673 0021455 0 ustar 00 <?php /** * MasterDetailsResponsePlanInfoFeaturesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponsePlanInfoFeaturesTest Class Doc Comment * * @category Class * @description MasterDetailsResponsePlanInfoFeatures * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponsePlanInfoFeaturesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponsePlanInfoFeatures" */ public function testMasterDetailsResponsePlanInfoFeatures() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "unitValue" */ public function testPropertyUnitValue() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "used" */ public function testPropertyUsed() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } } brevo-php/test/Model/GetBlockedDomainsTest.php 0000644 00000004547 15021222673 0015366 0 ustar 00 <?php /** * GetBlockedDomainsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetBlockedDomainsTest Class Doc Comment * * @category Class * @description list of blocked domains * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetBlockedDomainsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetBlockedDomains" */ public function testGetBlockedDomains() { } /** * Test attribute "domains" */ public function testPropertyDomains() { } } brevo-php/test/Model/SendSmtpEmailTest.php 0000644 00000007540 15021222673 0014551 0 ustar 00 <?php /** * SendSmtpEmailTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailTest Class Doc Comment * * @category Class * @description SendSmtpEmail * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmail" */ public function testSendSmtpEmail() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "to" */ public function testPropertyTo() { } /** * Test attribute "bcc" */ public function testPropertyBcc() { } /** * Test attribute "cc" */ public function testPropertyCc() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "textContent" */ public function testPropertyTextContent() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "attachment" */ public function testPropertyAttachment() { } /** * Test attribute "headers" */ public function testPropertyHeaders() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "params" */ public function testPropertyParams() { } /** * Test attribute "messageVersions" */ public function testPropertyMessageVersions() { } /** * Test attribute "tags" */ public function testPropertyTags() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "batchId" */ public function testPropertyBatchId() { } } brevo-php/test/Model/MasterDetailsResponseBillingInfoTest.php 0000644 00000005400 15021222673 0020432 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponseBillingInfoTest Class Doc Comment * * @category Class * @description Billing details of the master account organization * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponseBillingInfo" */ public function testMasterDetailsResponseBillingInfo() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "address" */ public function testPropertyAddress() { } } brevo-php/test/Model/GetCampaignRecipientsTest.php 0000644 00000004752 15021222673 0016253 0 ustar 00 <?php /** * GetCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCampaignRecipientsTest Class Doc Comment * * @category Class * @description GetCampaignRecipients * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCampaignRecipients" */ public function testGetCampaignRecipients() { } /** * Test attribute "lists" */ public function testPropertyLists() { } /** * Test attribute "exclusionLists" */ public function testPropertyExclusionLists() { } } brevo-php/test/Model/UpdateContactTest.php 0000644 00000005771 15021222673 0014606 0 ustar 00 <?php /** * UpdateContactTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateContactTest Class Doc Comment * * @category Class * @description UpdateContact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateContactTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateContact" */ public function testUpdateContact() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "extId" */ public function testPropertyExtId() { } /** * Test attribute "emailBlacklisted" */ public function testPropertyEmailBlacklisted() { } /** * Test attribute "smsBlacklisted" */ public function testPropertySmsBlacklisted() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "unlinkListIds" */ public function testPropertyUnlinkListIds() { } /** * Test attribute "smtpBlacklistSender" */ public function testPropertySmtpBlacklistSender() { } } brevo-php/test/Model/GetCouponCollectionTest.php 0000644 00000005614 15021222673 0015763 0 ustar 00 <?php /** * GetCouponCollectionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCouponCollectionTest Class Doc Comment * * @category Class * @description GetCouponCollection * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCouponCollectionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCouponCollection" */ public function testGetCouponCollection() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "defaultCoupon" */ public function testPropertyDefaultCoupon() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "totalCoupons" */ public function testPropertyTotalCoupons() { } /** * Test attribute "remainingCoupons" */ public function testPropertyRemainingCoupons() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoCreditsEmailsTest.php 0000644 00000005170 15021222673 0023234 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoCreditsEmailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoCreditsEmailsTest Class Doc Comment * * @category Class * @description Email credits remaining on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoCreditsEmailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoCreditsEmails" */ public function testSubAccountDetailsResponsePlanInfoCreditsEmails() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } } brevo-php/test/Model/DealTest.php 0000644 00000005166 15021222673 0012713 0 ustar 00 <?php /** * DealTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * DealTest Class Doc Comment * * @category Class * @description Deal Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Deal" */ public function testDeal() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "linkedContactsIds" */ public function testPropertyLinkedContactsIds() { } /** * Test attribute "linkedCompaniesIds" */ public function testPropertyLinkedCompaniesIds() { } } brevo-php/test/Model/SendSmtpEmailAttachmentTest.php 0000644 00000005105 15021222673 0016555 0 ustar 00 <?php /** * SendSmtpEmailAttachmentTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailAttachmentTest Class Doc Comment * * @category Class * @description SendSmtpEmailAttachment * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailAttachmentTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailAttachment" */ public function testSendSmtpEmailAttachment() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "content" */ public function testPropertyContent() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/PostContactInfoContactsTest.php 0000644 00000005272 15021222673 0016620 0 ustar 00 <?php /** * PostContactInfoContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PostContactInfoContactsTest Class Doc Comment * * @category Class * @description PostContactInfoContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostContactInfoContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "PostContactInfoContacts" */ public function testPostContactInfoContacts() { } /** * Test attribute "success" */ public function testPropertySuccess() { } /** * Test attribute "failure" */ public function testPropertyFailure() { } /** * Test attribute "total" */ public function testPropertyTotal() { } /** * Test attribute "processId" */ public function testPropertyProcessId() { } } brevo-php/test/Model/GetInvitedUsersListTest.php 0000644 00000004551 15021222673 0015763 0 ustar 00 <?php /** * GetInvitedUsersListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInvitedUsersListTest Class Doc Comment * * @category Class * @description GetInvitedUsersList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInvitedUsersListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInvitedUsersList" */ public function testGetInvitedUsersList() { } /** * Test attribute "users" */ public function testPropertyUsers() { } } brevo-php/test/Model/GetExtendedClientTest.php 0000644 00000004541 15021222673 0015401 0 ustar 00 <?php /** * GetExtendedClientTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedClientTest Class Doc Comment * * @category Class * @description GetExtendedClient * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedClientTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedClient" */ public function testGetExtendedClient() { } /** * Test attribute "address" */ public function testPropertyAddress() { } } brevo-php/test/Model/OrderTest.php 0000644 00000006111 15021222673 0013110 0 ustar 00 <?php /** * OrderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * OrderTest Class Doc Comment * * @category Class * @description Order * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Order" */ public function testOrder() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "updatedAt" */ public function testPropertyUpdatedAt() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "amount" */ public function testPropertyAmount() { } /** * Test attribute "products" */ public function testPropertyProducts() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "billing" */ public function testPropertyBilling() { } /** * Test attribute "coupons" */ public function testPropertyCoupons() { } } brevo-php/test/Model/GetSmsCampaignsTest.php 0000644 00000004674 15021222673 0015076 0 ustar 00 <?php /** * GetSmsCampaignsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsCampaignsTest Class Doc Comment * * @category Class * @description GetSmsCampaigns * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsCampaigns" */ public function testGetSmsCampaigns() { } /** * Test attribute "campaigns" */ public function testPropertyCampaigns() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/SubAccountUpdatePlanRequestTest.php 0000644 00000005014 15021222673 0017433 0 ustar 00 <?php /** * SubAccountUpdatePlanRequestTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountUpdatePlanRequestTest Class Doc Comment * * @category Class * @description Details of the plan to be changed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequestTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountUpdatePlanRequest" */ public function testSubAccountUpdatePlanRequest() { } /** * Test attribute "credits" */ public function testPropertyCredits() { } /** * Test attribute "features" */ public function testPropertyFeatures() { } } brevo-php/test/Model/GetExtendedContactDetailsTest.php 0000644 00000004627 15021222673 0017071 0 ustar 00 <?php /** * GetExtendedContactDetailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsTest Class Doc Comment * * @category Class * @description GetExtendedContactDetails * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetails" */ public function testGetExtendedContactDetails() { } /** * Test attribute "statistics" */ public function testPropertyStatistics() { } } brevo-php/test/Model/GetContactCampaignStatsTest.php 0000644 00000006417 15021222673 0016560 0 ustar 00 <?php /** * GetContactCampaignStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactCampaignStatsTest Class Doc Comment * * @category Class * @description Campaign Statistics for the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactCampaignStats" */ public function testGetContactCampaignStats() { } /** * Test attribute "messagesSent" */ public function testPropertyMessagesSent() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "complaints" */ public function testPropertyComplaints() { } /** * Test attribute "unsubscriptions" */ public function testPropertyUnsubscriptions() { } /** * Test attribute "opened" */ public function testPropertyOpened() { } /** * Test attribute "clicked" */ public function testPropertyClicked() { } /** * Test attribute "transacAttributes" */ public function testPropertyTransacAttributes() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } } brevo-php/test/Model/GetDeviceBrowserStatsTest.php 0000644 00000005300 15021222673 0016256 0 ustar 00 <?php /** * GetDeviceBrowserStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetDeviceBrowserStatsTest Class Doc Comment * * @category Class * @description GetDeviceBrowserStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDeviceBrowserStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetDeviceBrowserStats" */ public function testGetDeviceBrowserStats() { } /** * Test attribute "clickers" */ public function testPropertyClickers() { } /** * Test attribute "uniqueClicks" */ public function testPropertyUniqueClicks() { } /** * Test attribute "viewed" */ public function testPropertyViewed() { } /** * Test attribute "uniqueViews" */ public function testPropertyUniqueViews() { } } brevo-php/test/Model/GetSegmentsTest.php 0000644 00000004642 15021222673 0014271 0 ustar 00 <?php /** * GetSegmentsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSegmentsTest Class Doc Comment * * @category Class * @description GetSegments * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSegmentsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSegments" */ public function testGetSegments() { } /** * Test attribute "segments" */ public function testPropertySegments() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscriptionTest.php 0000644 00000005372 15021222673 0030216 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscriptionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscriptionTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscriptionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription" */ public function testGetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/GetSmtpTemplateOverviewTest.php 0000644 00000007135 15021222673 0016652 0 ustar 00 <?php /** * GetSmtpTemplateOverviewTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmtpTemplateOverviewTest Class Doc Comment * * @category Class * @description GetSmtpTemplateOverview * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplateOverviewTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmtpTemplateOverview" */ public function testGetSmtpTemplateOverview() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "isActive" */ public function testPropertyIsActive() { } /** * Test attribute "testSent" */ public function testPropertyTestSent() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } /** * Test attribute "doiTemplate" */ public function testPropertyDoiTemplate() { } } brevo-php/test/Model/MasterDetailsResponseBillingInfoNameTest.php 0000644 00000005105 15021222673 0021235 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfoNameTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponseBillingInfoNameTest Class Doc Comment * * @category Class * @description Billing name of master account holder * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfoNameTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponseBillingInfoName" */ public function testMasterDetailsResponseBillingInfoName() { } /** * Test attribute "givenName" */ public function testPropertyGivenName() { } /** * Test attribute "familyName" */ public function testPropertyFamilyName() { } } brevo-php/test/Model/NoteListTest.php 0000644 00000004311 15021222673 0013576 0 ustar 00 <?php /** * NoteListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * NoteListTest Class Doc Comment * * @category Class * @description List of notes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "NoteList" */ public function testNoteList() { } } brevo-php/test/Model/UpdateEmailCampaignTest.php 0000644 00000013073 15021222673 0015674 0 ustar 00 <?php /** * UpdateEmailCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateEmailCampaignTest Class Doc Comment * * @category Class * @description UpdateEmailCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateEmailCampaign" */ public function testUpdateEmailCampaign() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "htmlUrl" */ public function testPropertyHtmlUrl() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "previewText" */ public function testPropertyPreviewText() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "attachmentUrl" */ public function testPropertyAttachmentUrl() { } /** * Test attribute "inlineImageActivation" */ public function testPropertyInlineImageActivation() { } /** * Test attribute "mirrorActive" */ public function testPropertyMirrorActive() { } /** * Test attribute "recurring" */ public function testPropertyRecurring() { } /** * Test attribute "footer" */ public function testPropertyFooter() { } /** * Test attribute "header" */ public function testPropertyHeader() { } /** * Test attribute "utmCampaign" */ public function testPropertyUtmCampaign() { } /** * Test attribute "params" */ public function testPropertyParams() { } /** * Test attribute "sendAtBestTime" */ public function testPropertySendAtBestTime() { } /** * Test attribute "abTesting" */ public function testPropertyAbTesting() { } /** * Test attribute "subjectA" */ public function testPropertySubjectA() { } /** * Test attribute "subjectB" */ public function testPropertySubjectB() { } /** * Test attribute "splitRule" */ public function testPropertySplitRule() { } /** * Test attribute "winnerCriteria" */ public function testPropertyWinnerCriteria() { } /** * Test attribute "winnerDelay" */ public function testPropertyWinnerDelay() { } /** * Test attribute "ipWarmupEnable" */ public function testPropertyIpWarmupEnable() { } /** * Test attribute "initialQuota" */ public function testPropertyInitialQuota() { } /** * Test attribute "increaseRate" */ public function testPropertyIncreaseRate() { } /** * Test attribute "unsubscriptionPageId" */ public function testPropertyUnsubscriptionPageId() { } /** * Test attribute "updateFormId" */ public function testPropertyUpdateFormId() { } } brevo-php/test/Model/GetWATemplatesTest.php 0000644 00000004666 15021222673 0014700 0 ustar 00 <?php /** * GetWATemplatesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWATemplatesTest Class Doc Comment * * @category Class * @description GetWATemplates * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWATemplatesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWATemplates" */ public function testGetWATemplates() { } /** * Test attribute "templates" */ public function testPropertyTemplates() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetEmailCampaignsTest.php 0000644 00000004710 15021222673 0015352 0 ustar 00 <?php /** * GetEmailCampaignsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetEmailCampaignsTest Class Doc Comment * * @category Class * @description GetEmailCampaigns * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailCampaignsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetEmailCampaigns" */ public function testGetEmailCampaigns() { } /** * Test attribute "campaigns" */ public function testPropertyCampaigns() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetAttributesTest.php 0000644 00000004517 15021222673 0014633 0 ustar 00 <?php /** * GetAttributesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAttributesTest Class Doc Comment * * @category Class * @description GetAttributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAttributes" */ public function testGetAttributes() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } } brevo-php/test/Model/GetWebhookTest.php 0000644 00000005631 15021222673 0014101 0 ustar 00 <?php /** * GetWebhookTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWebhookTest Class Doc Comment * * @category Class * @description GetWebhook * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWebhookTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWebhook" */ public function testGetWebhook() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "description" */ public function testPropertyDescription() { } /** * Test attribute "events" */ public function testPropertyEvents() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/AddContactToListTest.php 0000644 00000004670 15021222673 0015210 0 ustar 00 <?php /** * AddContactToListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AddContactToListTest Class Doc Comment * * @category Class * @description AddContactToList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddContactToListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AddContactToList" */ public function testAddContactToList() { } /** * Test attribute "emails" */ public function testPropertyEmails() { } /** * Test attribute "ids" */ public function testPropertyIds() { } } brevo-php/test/Model/GetExtendedCampaignOverviewSenderTest.php 0000644 00000005173 15021222673 0020574 0 ustar 00 <?php /** * GetExtendedCampaignOverviewSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedCampaignOverviewSenderTest Class Doc Comment * * @category Class * @description GetExtendedCampaignOverviewSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignOverviewSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedCampaignOverviewSender" */ public function testGetExtendedCampaignOverviewSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/Body11Test.php 0000644 00000004431 15021222673 0013077 0 ustar 00 <?php /** * Body11Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body11Test Class Doc Comment * * @category Class * @description Body11 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body11Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body11" */ public function testBody11() { } /** * Test attribute "text" */ public function testPropertyText() { } } brevo-php/test/Model/GetStatsByDeviceTest.php 0000644 00000005214 15021222673 0015211 0 ustar 00 <?php /** * GetStatsByDeviceTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetStatsByDeviceTest Class Doc Comment * * @category Class * @description GetStatsByDevice * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByDeviceTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetStatsByDevice" */ public function testGetStatsByDevice() { } /** * Test attribute "desktop" */ public function testPropertyDesktop() { } /** * Test attribute "mobile" */ public function testPropertyMobile() { } /** * Test attribute "tablet" */ public function testPropertyTablet() { } /** * Test attribute "unknown" */ public function testPropertyUnknown() { } } brevo-php/test/Model/GetAllExternalFeedsTest.php 0000644 00000004714 15021222673 0015666 0 ustar 00 <?php /** * GetAllExternalFeedsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAllExternalFeedsTest Class Doc Comment * * @category Class * @description GetAllExternalFeeds * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAllExternalFeedsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAllExternalFeeds" */ public function testGetAllExternalFeeds() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "feeds" */ public function testPropertyFeeds() { } } brevo-php/test/Model/GetFoldersTest.php 0000644 00000004632 15021222673 0014101 0 ustar 00 <?php /** * GetFoldersTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetFoldersTest Class Doc Comment * * @category Class * @description GetFolders * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetFoldersTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetFolders" */ public function testGetFolders() { } /** * Test attribute "folders" */ public function testPropertyFolders() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetProductsTest.php 0000644 00000004642 15021222673 0014307 0 ustar 00 <?php /** * GetProductsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetProductsTest Class Doc Comment * * @category Class * @description GetProducts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProductsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetProducts" */ public function testGetProducts() { } /** * Test attribute "products" */ public function testPropertyProducts() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetIpFromSenderTest.php 0000644 00000005162 15021222673 0015037 0 ustar 00 <?php /** * GetIpFromSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetIpFromSenderTest Class Doc Comment * * @category Class * @description GetIpFromSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpFromSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetIpFromSender" */ public function testGetIpFromSender() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } /** * Test attribute "weight" */ public function testPropertyWeight() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsDeliveredTest.php 0000644 00000005164 15021222673 0022765 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsDeliveredTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsDeliveredTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsDelivered * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsDeliveredTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsDelivered" */ public function testGetExtendedContactDetailsStatisticsDelivered() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } } brevo-php/test/Model/GetSmsCampaignOverviewTest.php 0000644 00000006116 15021222673 0016433 0 ustar 00 <?php /** * GetSmsCampaignOverviewTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsCampaignOverviewTest Class Doc Comment * * @category Class * @description GetSmsCampaignOverview * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignOverviewTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsCampaignOverview" */ public function testGetSmsCampaignOverview() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "content" */ public function testPropertyContent() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/GetExtendedListCampaignStatsTest.php 0000644 00000005014 15021222673 0017551 0 ustar 00 <?php /** * GetExtendedListCampaignStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedListCampaignStatsTest Class Doc Comment * * @category Class * @description GetExtendedListCampaignStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedListCampaignStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedListCampaignStats" */ public function testGetExtendedListCampaignStats() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "stats" */ public function testPropertyStats() { } } brevo-php/test/Model/GetCategoryDetailsTest.php 0000644 00000005540 15021222673 0015565 0 ustar 00 <?php /** * GetCategoryDetailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCategoryDetailsTest Class Doc Comment * * @category Class * @description GetCategoryDetails * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCategoryDetailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCategoryDetails" */ public function testGetCategoryDetails() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "isDeleted" */ public function testPropertyIsDeleted() { } } brevo-php/test/Model/SendSmtpEmailReplyTo1Test.php 0000644 00000005164 15021222673 0016151 0 ustar 00 <?php /** * SendSmtpEmailReplyTo1Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailReplyTo1Test Class Doc Comment * * @category Class * @description Email (required), along with name (optional), on which transactional mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\", \"name\":\"Ann\"} * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailReplyTo1Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailReplyTo1" */ public function testSendSmtpEmailReplyTo1() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/CreateEmailCampaignSenderTest.php 0000644 00000005505 15021222673 0017017 0 ustar 00 <?php /** * CreateEmailCampaignSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateEmailCampaignSenderTest Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaignSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateEmailCampaignSender" */ public function testCreateEmailCampaignSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/UpdateChildTest.php 0000644 00000005345 15021222673 0014233 0 ustar 00 <?php /** * UpdateChildTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateChildTest Class Doc Comment * * @category Class * @description UpdateChild * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChildTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateChild" */ public function testUpdateChild() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "firstName" */ public function testPropertyFirstName() { } /** * Test attribute "lastName" */ public function testPropertyLastName() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "password" */ public function testPropertyPassword() { } } brevo-php/test/Model/UploadImageModelTest.php 0000644 00000004523 15021222673 0015212 0 ustar 00 <?php /** * UploadImageModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UploadImageModelTest Class Doc Comment * * @category Class * @description UploadImageModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UploadImageModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UploadImageModel" */ public function testUploadImageModel() { } /** * Test attribute "url" */ public function testPropertyUrl() { } } brevo-php/test/Model/CreateUpdateBatchProductsModelTest.php 0000644 00000005052 15021222673 0020055 0 ustar 00 <?php /** * CreateUpdateBatchProductsModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateBatchProductsModelTest Class Doc Comment * * @category Class * @description CreateUpdateBatchProductsModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchProductsModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateBatchProductsModel" */ public function testCreateUpdateBatchProductsModel() { } /** * Test attribute "createdCount" */ public function testPropertyCreatedCount() { } /** * Test attribute "updatedCount" */ public function testPropertyUpdatedCount() { } } brevo-php/test/Model/GetChildDomainTest.php 0000644 00000004662 15021222673 0014661 0 ustar 00 <?php /** * GetChildDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildDomainTest Class Doc Comment * * @category Class * @description GetChildDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildDomain" */ public function testGetChildDomain() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } /** * Test attribute "active" */ public function testPropertyActive() { } } brevo-php/test/Model/Body7Test.php 0000644 00000006304 15021222673 0013025 0 ustar 00 <?php /** * Body7Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body7Test Class Doc Comment * * @category Class * @description Body7 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body7Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body7" */ public function testBody7() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "duration" */ public function testPropertyDuration() { } /** * Test attribute "taskTypeId" */ public function testPropertyTaskTypeId() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "notes" */ public function testPropertyNotes() { } /** * Test attribute "done" */ public function testPropertyDone() { } /** * Test attribute "assignToId" */ public function testPropertyAssignToId() { } /** * Test attribute "contactsIds" */ public function testPropertyContactsIds() { } /** * Test attribute "dealsIds" */ public function testPropertyDealsIds() { } /** * Test attribute "companiesIds" */ public function testPropertyCompaniesIds() { } } brevo-php/test/Model/GetSendersListSendersTest.php 0000644 00000005367 15021222673 0016274 0 ustar 00 <?php /** * GetSendersListSendersTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSendersListSendersTest Class Doc Comment * * @category Class * @description GetSendersListSenders * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSendersListSendersTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSendersListSenders" */ public function testGetSendersListSenders() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "active" */ public function testPropertyActive() { } /** * Test attribute "ips" */ public function testPropertyIps() { } } brevo-php/test/Model/GetScheduledEmailByMessageIdTest.php 0000644 00000005174 15021222673 0017432 0 ustar 00 <?php /** * GetScheduledEmailByMessageIdTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetScheduledEmailByMessageIdTest Class Doc Comment * * @category Class * @description GetScheduledEmailByMessageId * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByMessageIdTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetScheduledEmailByMessageId" */ public function testGetScheduledEmailByMessageId() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "status" */ public function testPropertyStatus() { } } brevo-php/test/Model/GetCategoriesTest.php 0000644 00000004662 15021222673 0014573 0 ustar 00 <?php /** * GetCategoriesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCategoriesTest Class Doc Comment * * @category Class * @description GetCategories * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCategoriesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCategories" */ public function testGetCategories() { } /** * Test attribute "categories" */ public function testPropertyCategories() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/ExportWebhooksHistoryTest.php 0000644 00000006255 15021222673 0016413 0 ustar 00 <?php /** * ExportWebhooksHistoryTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ExportWebhooksHistoryTest Class Doc Comment * * @category Class * @description ExportWebhooksHistory * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ExportWebhooksHistoryTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ExportWebhooksHistory" */ public function testExportWebhooksHistory() { } /** * Test attribute "days" */ public function testPropertyDays() { } /** * Test attribute "startDate" */ public function testPropertyStartDate() { } /** * Test attribute "endDate" */ public function testPropertyEndDate() { } /** * Test attribute "sort" */ public function testPropertySort() { } /** * Test attribute "event" */ public function testPropertyEvent() { } /** * Test attribute "notifyURL" */ public function testPropertyNotifyURL() { } /** * Test attribute "webhookId" */ public function testPropertyWebhookId() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } } brevo-php/test/Model/RequestContactImportNewListTest.php 0000644 00000005116 15021222673 0017506 0 ustar 00 <?php /** * RequestContactImportNewListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestContactImportNewListTest Class Doc Comment * * @category Class * @description To create a new list and import the contacts into it, pass the listName and an optional folderId. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImportNewListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestContactImportNewList" */ public function testRequestContactImportNewList() { } /** * Test attribute "listName" */ public function testPropertyListName() { } /** * Test attribute "folderId" */ public function testPropertyFolderId() { } } brevo-php/test/Model/GetContactDetailsTest.php 0000644 00000006315 15021222673 0015404 0 ustar 00 <?php /** * GetContactDetailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactDetailsTest Class Doc Comment * * @category Class * @description GetContactDetails * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactDetailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactDetails" */ public function testGetContactDetails() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "emailBlacklisted" */ public function testPropertyEmailBlacklisted() { } /** * Test attribute "smsBlacklisted" */ public function testPropertySmsBlacklisted() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "listUnsubscribed" */ public function testPropertyListUnsubscribed() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } } brevo-php/test/Model/GetTransacSmsReportTest.php 0000644 00000004555 15021222673 0015761 0 ustar 00 <?php /** * GetTransacSmsReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacSmsReportTest Class Doc Comment * * @category Class * @description GetTransacSmsReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacSmsReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacSmsReport" */ public function testGetTransacSmsReport() { } /** * Test attribute "reports" */ public function testPropertyReports() { } } brevo-php/test/Model/GetSmsEventReportEventsTest.php 0000644 00000005743 15021222673 0016634 0 ustar 00 <?php /** * GetSmsEventReportEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsEventReportEventsTest Class Doc Comment * * @category Class * @description GetSmsEventReportEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsEventReportEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsEventReportEvents" */ public function testGetSmsEventReportEvents() { } /** * Test attribute "phoneNumber" */ public function testPropertyPhoneNumber() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "event" */ public function testPropertyEvent() { } /** * Test attribute "reason" */ public function testPropertyReason() { } /** * Test attribute "reply" */ public function testPropertyReply() { } /** * Test attribute "tag" */ public function testPropertyTag() { } } brevo-php/test/Model/SendSmtpEmailBccTest.php 0000644 00000004670 15021222673 0015162 0 ustar 00 <?php /** * SendSmtpEmailBccTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailBccTest Class Doc Comment * * @category Class * @description SendSmtpEmailBcc * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailBccTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailBcc" */ public function testSendSmtpEmailBcc() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetTransacEmailContentTest.php 0000644 00000005755 15021222673 0016410 0 ustar 00 <?php /** * GetTransacEmailContentTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacEmailContentTest Class Doc Comment * * @category Class * @description GetTransacEmailContent * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailContentTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacEmailContent" */ public function testGetTransacEmailContent() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "events" */ public function testPropertyEvents() { } /** * Test attribute "body" */ public function testPropertyBody() { } /** * Test attribute "attachmentCount" */ public function testPropertyAttachmentCount() { } } brevo-php/test/Model/UpdateAttributeEnumerationTest.php 0000644 00000004766 15021222674 0017371 0 ustar 00 <?php /** * UpdateAttributeEnumerationTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateAttributeEnumerationTest Class Doc Comment * * @category Class * @description UpdateAttributeEnumeration * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateAttributeEnumerationTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateAttributeEnumeration" */ public function testUpdateAttributeEnumeration() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "label" */ public function testPropertyLabel() { } } brevo-php/test/Model/CompanyAttributesInnerTest.php 0000644 00000005511 15021222674 0016512 0 ustar 00 <?php /** * CompanyAttributesInnerTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CompanyAttributesInnerTest Class Doc Comment * * @category Class * @description List of attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompanyAttributesInnerTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CompanyAttributesInner" */ public function testCompanyAttributesInner() { } /** * Test attribute "internalName" */ public function testPropertyInternalName() { } /** * Test attribute "label" */ public function testPropertyLabel() { } /** * Test attribute "attributeTypeName" */ public function testPropertyAttributeTypeName() { } /** * Test attribute "attributeOptions" */ public function testPropertyAttributeOptions() { } /** * Test attribute "isRequired" */ public function testPropertyIsRequired() { } } brevo-php/test/Model/SubAccountsResponseTest.php 0000644 00000004730 15021222674 0016013 0 ustar 00 <?php /** * SubAccountsResponseTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountsResponseTest Class Doc Comment * * @category Class * @description SubAccountsResponse * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountsResponseTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountsResponse" */ public function testSubAccountsResponse() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "subAccounts" */ public function testPropertySubAccounts() { } } brevo-php/test/Model/NoteIdTest.php 0000644 00000004436 15021222674 0013230 0 ustar 00 <?php /** * NoteIdTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * NoteIdTest Class Doc Comment * * @category Class * @description Updated Note ID * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class NoteIdTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "NoteId" */ public function testNoteId() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/RequestContactImportJsonBodyTest.php 0000644 00000005014 15021222674 0017646 0 ustar 00 <?php /** * RequestContactImportJsonBodyTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestContactImportJsonBodyTest Class Doc Comment * * @category Class * @description RequestContactImportJsonBody * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImportJsonBodyTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestContactImportJsonBody" */ public function testRequestContactImportJsonBody() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } } brevo-php/test/Model/GetExtendedCampaignStatsGlobalStatsTest.php 0000644 00000004545 15021222674 0021066 0 ustar 00 <?php /** * GetExtendedCampaignStatsGlobalStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedCampaignStatsGlobalStatsTest Class Doc Comment * * @category Class * @description Overall statistics of the campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignStatsGlobalStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedCampaignStatsGlobalStats" */ public function testGetExtendedCampaignStatsGlobalStats() { } } brevo-php/test/Model/PostSendSmsTestFailedTest.php 0000644 00000005302 15021222674 0016226 0 ustar 00 <?php /** * PostSendSmsTestFailedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PostSendSmsTestFailedTest Class Doc Comment * * @category Class * @description PostSendSmsTestFailed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostSendSmsTestFailedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "PostSendSmsTestFailed" */ public function testPostSendSmsTestFailed() { } /** * Test attribute "code" */ public function testPropertyCode() { } /** * Test attribute "message" */ public function testPropertyMessage() { } /** * Test attribute "unexistingSms" */ public function testPropertyUnexistingSms() { } /** * Test attribute "withoutListSms" */ public function testPropertyWithoutListSms() { } } brevo-php/test/Model/MasterDetailsResponseTest.php 0000644 00000005763 15021222674 0016332 0 ustar 00 <?php /** * MasterDetailsResponseTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponseTest Class Doc Comment * * @category Class * @description MasterDetailsResponse * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponse" */ public function testMasterDetailsResponse() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "currencyCode" */ public function testPropertyCurrencyCode() { } /** * Test attribute "timezone" */ public function testPropertyTimezone() { } /** * Test attribute "billingInfo" */ public function testPropertyBillingInfo() { } /** * Test attribute "planInfo" */ public function testPropertyPlanInfo() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsOpenedTest.php 0000644 00000005442 15021222674 0022274 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsOpenedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsOpenedTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsOpened * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsOpenedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsOpened" */ public function testGetExtendedContactDetailsStatisticsOpened() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/OrderBatchTest.php 0000644 00000004640 15021222674 0014060 0 ustar 00 <?php /** * OrderBatchTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * OrderBatchTest Class Doc Comment * * @category Class * @description OrderBatch * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderBatchTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "OrderBatch" */ public function testOrderBatch() { } /** * Test attribute "orders" */ public function testPropertyOrders() { } /** * Test attribute "notifyUrl" */ public function testPropertyNotifyUrl() { } } brevo-php/test/Model/InlineResponse2013Test.php 0000644 00000004553 15021222674 0015311 0 ustar 00 <?php /** * InlineResponse2013Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse2013Test Class Doc Comment * * @category Class * @description InlineResponse2013 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2013Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse2013" */ public function testInlineResponse2013() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } } brevo-php/test/Model/CreateUpdateCategoriesTest.php 0000644 00000005240 15021222674 0016414 0 ustar 00 <?php /** * CreateUpdateCategoriesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateCategoriesTest Class Doc Comment * * @category Class * @description CreateUpdateCategories * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateCategoriesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateCategories" */ public function testCreateUpdateCategories() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "deletedAt" */ public function testPropertyDeletedAt() { } } brevo-php/test/Model/Body2Test.php 0000644 00000005206 15021222674 0013021 0 ustar 00 <?php /** * Body2Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body2Test Class Doc Comment * * @category Class * @description Body2 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body2Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body2" */ public function testBody2() { } /** * Test attribute "linkContactIds" */ public function testPropertyLinkContactIds() { } /** * Test attribute "unlinkContactIds" */ public function testPropertyUnlinkContactIds() { } /** * Test attribute "linkDealsIds" */ public function testPropertyLinkDealsIds() { } /** * Test attribute "unlinkDealsIds" */ public function testPropertyUnlinkDealsIds() { } } brevo-php/test/Model/UpdateBatchContactsTest.php 0000644 00000004557 15021222674 0015735 0 ustar 00 <?php /** * UpdateBatchContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateBatchContactsTest Class Doc Comment * * @category Class * @description UpdateBatchContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateBatchContacts" */ public function testUpdateBatchContacts() { } /** * Test attribute "contacts" */ public function testPropertyContacts() { } } brevo-php/test/Model/GetExternalFeedByUUIDTest.php 0000644 00000006734 15021222674 0016041 0 ustar 00 <?php /** * GetExternalFeedByUUIDTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExternalFeedByUUIDTest Class Doc Comment * * @category Class * @description GetExternalFeedByUUID * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExternalFeedByUUIDTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExternalFeedByUUID" */ public function testGetExternalFeedByUUID() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "authType" */ public function testPropertyAuthType() { } /** * Test attribute "username" */ public function testPropertyUsername() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "token" */ public function testPropertyToken() { } /** * Test attribute "headers" */ public function testPropertyHeaders() { } /** * Test attribute "maxRetries" */ public function testPropertyMaxRetries() { } /** * Test attribute "cache" */ public function testPropertyCache() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/GetAttributesAttributesTest.php 0000644 00000005457 15021222674 0016707 0 ustar 00 <?php /** * GetAttributesAttributesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAttributesAttributesTest Class Doc Comment * * @category Class * @description GetAttributesAttributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAttributesAttributesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAttributesAttributes" */ public function testGetAttributesAttributes() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "category" */ public function testPropertyCategory() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "enumeration" */ public function testPropertyEnumeration() { } /** * Test attribute "calculatedValue" */ public function testPropertyCalculatedValue() { } } brevo-php/test/Model/BodyVariablesItemsTest.php 0000644 00000004400 15021222674 0015565 0 ustar 00 <?php /** * BodyVariablesItemsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * BodyVariablesItemsTest Class Doc Comment * * @category Class * @description BodyVariablesItems * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class BodyVariablesItemsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "BodyVariablesItems" */ public function testBodyVariablesItems() { } } brevo-php/test/Model/GetTransacEmailContentEventsTest.php 0000644 00000004776 15021222674 0017600 0 ustar 00 <?php /** * GetTransacEmailContentEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacEmailContentEventsTest Class Doc Comment * * @category Class * @description GetTransacEmailContentEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailContentEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacEmailContentEvents" */ public function testGetTransacEmailContentEvents() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "time" */ public function testPropertyTime() { } } brevo-php/test/Model/GetChildInfoCreditsTest.php 0000644 00000004761 15021222674 0015664 0 ustar 00 <?php /** * GetChildInfoCreditsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoCreditsTest Class Doc Comment * * @category Class * @description Credits available for your child * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoCreditsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfoCredits" */ public function testGetChildInfoCredits() { } /** * Test attribute "emailCredits" */ public function testPropertyEmailCredits() { } /** * Test attribute "smsCredits" */ public function testPropertySmsCredits() { } } brevo-php/test/Model/GetStatsByDomainTest.php 0000644 00000004364 15021222674 0015227 0 ustar 00 <?php /** * GetStatsByDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetStatsByDomainTest Class Doc Comment * * @category Class * @description GetStatsByDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetStatsByDomain" */ public function testGetStatsByDomain() { } } brevo-php/test/Model/AuthenticateDomainModelTest.php 0000644 00000004762 15021222674 0016577 0 ustar 00 <?php /** * AuthenticateDomainModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AuthenticateDomainModelTest Class Doc Comment * * @category Class * @description AuthenticateDomainModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AuthenticateDomainModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AuthenticateDomainModel" */ public function testAuthenticateDomainModel() { } /** * Test attribute "domainName" */ public function testPropertyDomainName() { } /** * Test attribute "message" */ public function testPropertyMessage() { } } brevo-php/test/Model/GetSmsCampaignRecipientsTest.php 0000644 00000004444 15021222674 0016735 0 ustar 00 <?php /** * GetSmsCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsCampaignRecipientsTest Class Doc Comment * * @category Class * @description GetSmsCampaignRecipients * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsCampaignRecipients" */ public function testGetSmsCampaignRecipients() { } } brevo-php/test/Model/GetInboundEmailEventsByUuidAttachmentsTest.php 0000644 00000005446 15021222674 0021561 0 ustar 00 <?php /** * GetInboundEmailEventsByUuidAttachmentsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInboundEmailEventsByUuidAttachmentsTest Class Doc Comment * * @category Class * @description GetInboundEmailEventsByUuidAttachments * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuidAttachmentsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInboundEmailEventsByUuidAttachments" */ public function testGetInboundEmailEventsByUuidAttachments() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "contentType" */ public function testPropertyContentType() { } /** * Test attribute "contentId" */ public function testPropertyContentId() { } /** * Test attribute "contentLength" */ public function testPropertyContentLength() { } } brevo-php/test/Model/CreateUpdateProductsTest.php 0000644 00000006376 15021222674 0016145 0 ustar 00 <?php /** * CreateUpdateProductsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateProductsTest Class Doc Comment * * @category Class * @description CreateUpdateProducts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateProductsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateProducts" */ public function testCreateUpdateProducts() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "imageUrl" */ public function testPropertyImageUrl() { } /** * Test attribute "sku" */ public function testPropertySku() { } /** * Test attribute "price" */ public function testPropertyPrice() { } /** * Test attribute "categories" */ public function testPropertyCategories() { } /** * Test attribute "parentId" */ public function testPropertyParentId() { } /** * Test attribute "metaInfo" */ public function testPropertyMetaInfo() { } /** * Test attribute "deletedAt" */ public function testPropertyDeletedAt() { } } brevo-php/test/Model/CreateDomainModelTest.php 0000644 00000005230 15021222674 0015353 0 ustar 00 <?php /** * CreateDomainModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateDomainModelTest Class Doc Comment * * @category Class * @description CreateDomainModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateDomainModel" */ public function testCreateDomainModel() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "domainName" */ public function testPropertyDomainName() { } /** * Test attribute "message" */ public function testPropertyMessage() { } /** * Test attribute "dnsRecords" */ public function testPropertyDnsRecords() { } } brevo-php/test/Model/Body5Test.php 0000644 00000005216 15021222674 0013025 0 ustar 00 <?php /** * Body5Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body5Test Class Doc Comment * * @category Class * @description Body5 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body5Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body5" */ public function testBody5() { } /** * Test attribute "linkContactIds" */ public function testPropertyLinkContactIds() { } /** * Test attribute "unlinkContactIds" */ public function testPropertyUnlinkContactIds() { } /** * Test attribute "linkCompanyIds" */ public function testPropertyLinkCompanyIds() { } /** * Test attribute "unlinkCompanyIds" */ public function testPropertyUnlinkCompanyIds() { } } brevo-php/test/Model/GetWhatsAppConfigTest.php 0000644 00000005776 15021222674 0015373 0 ustar 00 <?php /** * GetWhatsAppConfigTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsAppConfigTest Class Doc Comment * * @category Class * @description GetWhatsAppConfig * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsAppConfigTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsAppConfig" */ public function testGetWhatsAppConfig() { } /** * Test attribute "whatsappBusinessAccountId" */ public function testPropertyWhatsappBusinessAccountId() { } /** * Test attribute "sendingLimit" */ public function testPropertySendingLimit() { } /** * Test attribute "phoneNumberQuality" */ public function testPropertyPhoneNumberQuality() { } /** * Test attribute "whatsappBusinessAccountStatus" */ public function testPropertyWhatsappBusinessAccountStatus() { } /** * Test attribute "businessStatus" */ public function testPropertyBusinessStatus() { } /** * Test attribute "phoneNumberNameStatus" */ public function testPropertyPhoneNumberNameStatus() { } } brevo-php/test/Model/ComponentItemsTest.php 0000644 00000004652 15021222674 0015012 0 ustar 00 <?php /** * ComponentItemsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ComponentItemsTest Class Doc Comment * * @category Class * @description ComponentItems * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ComponentItemsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ComponentItems" */ public function testComponentItems() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "text" */ public function testPropertyText() { } } brevo-php/test/Model/AbTestVersionClicksInnerTest.php 0000644 00000005137 15021222674 0016722 0 ustar 00 <?php /** * AbTestVersionClicksInnerTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestVersionClicksInnerTest Class Doc Comment * * @category Class * @description AbTestVersionClicksInner * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionClicksInnerTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestVersionClicksInner" */ public function testAbTestVersionClicksInner() { } /** * Test attribute "link" */ public function testPropertyLink() { } /** * Test attribute "clicksCount" */ public function testPropertyClicksCount() { } /** * Test attribute "clickRate" */ public function testPropertyClickRate() { } } brevo-php/test/Model/SendTransacSmsTest.php 0000644 00000006066 15021222674 0014737 0 ustar 00 <?php /** * SendTransacSmsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendTransacSmsTest Class Doc Comment * * @category Class * @description SendTransacSms * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTransacSmsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendTransacSms" */ public function testSendTransacSms() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "recipient" */ public function testPropertyRecipient() { } /** * Test attribute "content" */ public function testPropertyContent() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "webUrl" */ public function testPropertyWebUrl() { } /** * Test attribute "unicodeEnabled" */ public function testPropertyUnicodeEnabled() { } /** * Test attribute "organisationPrefix" */ public function testPropertyOrganisationPrefix() { } } brevo-php/test/Model/ManageIpTest.php 0000644 00000004441 15021222674 0013523 0 ustar 00 <?php /** * ManageIpTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ManageIpTest Class Doc Comment * * @category Class * @description ManageIp * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ManageIpTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ManageIp" */ public function testManageIp() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/DealAttributesTest.php 0000644 00000004361 15021222674 0014757 0 ustar 00 <?php /** * DealAttributesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * DealAttributesTest Class Doc Comment * * @category Class * @description List of deal attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealAttributesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "DealAttributes" */ public function testDealAttributes() { } } brevo-php/test/Model/GetExtendedListTest.php 0000644 00000005244 15021222674 0015100 0 ustar 00 <?php /** * GetExtendedListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedListTest Class Doc Comment * * @category Class * @description GetExtendedList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedList" */ public function testGetExtendedList() { } /** * Test attribute "folderId" */ public function testPropertyFolderId() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "campaignStats" */ public function testPropertyCampaignStats() { } /** * Test attribute "dynamicList" */ public function testPropertyDynamicList() { } } brevo-php/test/Model/AbTestCampaignResultTest.php 0000644 00000006244 15021222674 0016066 0 ustar 00 <?php /** * AbTestCampaignResultTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestCampaignResultTest Class Doc Comment * * @category Class * @description AbTestCampaignResult * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestCampaignResultTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestCampaignResult" */ public function testAbTestCampaignResult() { } /** * Test attribute "winningVersion" */ public function testPropertyWinningVersion() { } /** * Test attribute "winningCriteria" */ public function testPropertyWinningCriteria() { } /** * Test attribute "winningSubjectLine" */ public function testPropertyWinningSubjectLine() { } /** * Test attribute "openRate" */ public function testPropertyOpenRate() { } /** * Test attribute "clickRate" */ public function testPropertyClickRate() { } /** * Test attribute "winningVersionRate" */ public function testPropertyWinningVersionRate() { } /** * Test attribute "statistics" */ public function testPropertyStatistics() { } /** * Test attribute "clickedLinks" */ public function testPropertyClickedLinks() { } } brevo-php/test/Model/GetAccountRelayTest.php 0000644 00000004731 15021222674 0015075 0 ustar 00 <?php /** * GetAccountRelayTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountRelayTest Class Doc Comment * * @category Class * @description Information about your transactional email account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountRelayTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountRelay" */ public function testGetAccountRelay() { } /** * Test attribute "enabled" */ public function testPropertyEnabled() { } /** * Test attribute "data" */ public function testPropertyData() { } } brevo-php/test/Model/GetDomainConfigurationModelTest.php 0000644 00000005344 15021222674 0017425 0 ustar 00 <?php /** * GetDomainConfigurationModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetDomainConfigurationModelTest Class Doc Comment * * @category Class * @description GetDomainConfigurationModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainConfigurationModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetDomainConfigurationModel" */ public function testGetDomainConfigurationModel() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } /** * Test attribute "verified" */ public function testPropertyVerified() { } /** * Test attribute "authenticated" */ public function testPropertyAuthenticated() { } /** * Test attribute "dnsRecords" */ public function testPropertyDnsRecords() { } } brevo-php/test/Model/SendSmsTest.php 0000644 00000005345 15021222674 0013422 0 ustar 00 <?php /** * SendSmsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmsTest Class Doc Comment * * @category Class * @description SendSms * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSms" */ public function testSendSms() { } /** * Test attribute "reference" */ public function testPropertyReference() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "smsCount" */ public function testPropertySmsCount() { } /** * Test attribute "usedCredits" */ public function testPropertyUsedCredits() { } /** * Test attribute "remainingCredits" */ public function testPropertyRemainingCredits() { } } brevo-php/test/Model/InlineResponse2012Test.php 0000644 00000004535 15021222674 0015310 0 ustar 00 <?php /** * InlineResponse2012Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse2012Test Class Doc Comment * * @category Class * @description InlineResponse2012 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2012Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse2012" */ public function testInlineResponse2012() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/GetProcessTest.php 0000644 00000005136 15021222674 0014122 0 ustar 00 <?php /** * GetProcessTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetProcessTest Class Doc Comment * * @category Class * @description GetProcess * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProcessTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetProcess" */ public function testGetProcess() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "exportUrl" */ public function testPropertyExportUrl() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscriptionTest.php 0000644 00000005541 15021222674 0030103 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscriptionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscriptionTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscriptionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription" */ public function testGetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/GetExternalFeedByUUIDHeadersTest.php 0000644 00000005000 15021222674 0017316 0 ustar 00 <?php /** * GetExternalFeedByUUIDHeadersTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExternalFeedByUUIDHeadersTest Class Doc Comment * * @category Class * @description GetExternalFeedByUUIDHeaders * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExternalFeedByUUIDHeadersTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExternalFeedByUUIDHeaders" */ public function testGetExternalFeedByUUIDHeaders() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "value" */ public function testPropertyValue() { } } brevo-php/test/Model/SsoTokenRequestTest.php 0000644 00000005162 15021222674 0015161 0 ustar 00 <?php /** * SsoTokenRequestTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SsoTokenRequestTest Class Doc Comment * * @category Class * @description SsoTokenRequest * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SsoTokenRequestTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SsoTokenRequest" */ public function testSsoTokenRequest() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "target" */ public function testPropertyTarget() { } /** * Test attribute "url" */ public function testPropertyUrl() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsMessagesSentTest.php 0000644 00000005206 15021222674 0023461 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsMessagesSentTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsMessagesSentTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsMessagesSent * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsMessagesSentTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsMessagesSent" */ public function testGetExtendedContactDetailsStatisticsMessagesSent() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } } brevo-php/test/Model/DealsListTest.php 0000644 00000004461 15021222674 0013730 0 ustar 00 <?php /** * DealsListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * DealsListTest Class Doc Comment * * @category Class * @description List of Deals * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DealsListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "DealsList" */ public function testDealsList() { } /** * Test attribute "items" */ public function testPropertyItems() { } } brevo-php/test/Model/CreateUpdateBatchCategoryModelTest.php 0000644 00000005052 15021222674 0020030 0 ustar 00 <?php /** * CreateUpdateBatchCategoryModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateBatchCategoryModelTest Class Doc Comment * * @category Class * @description CreateUpdateBatchCategoryModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchCategoryModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateBatchCategoryModel" */ public function testCreateUpdateBatchCategoryModel() { } /** * Test attribute "createdCount" */ public function testPropertyCreatedCount() { } /** * Test attribute "updatedCount" */ public function testPropertyUpdatedCount() { } } brevo-php/test/Model/UpdateEmailCampaignRecipientsTest.php 0000644 00000005253 15021222674 0017724 0 ustar 00 <?php /** * UpdateEmailCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateEmailCampaignRecipientsTest Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateEmailCampaignRecipients" */ public function testUpdateEmailCampaignRecipients() { } /** * Test attribute "exclusionListIds" */ public function testPropertyExclusionListIds() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "segmentIds" */ public function testPropertySegmentIds() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoFeaturesLandingPageTest.php 0000644 00000005200 15021222674 0024347 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesLandingPageTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoFeaturesLandingPageTest Class Doc Comment * * @category Class * @description Landing page details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesLandingPageTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoFeaturesLandingPage" */ public function testSubAccountDetailsResponsePlanInfoFeaturesLandingPage() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsClickedTest.php 0000644 00000005140 15021222674 0022413 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsClickedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsClickedTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsClicked * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsClickedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsClicked" */ public function testGetExtendedContactDetailsStatisticsClicked() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "links" */ public function testPropertyLinks() { } } brevo-php/test/Model/GetInboundEmailEventsEventsTest.php 0000644 00000005310 15021222674 0017416 0 ustar 00 <?php /** * GetInboundEmailEventsEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInboundEmailEventsEventsTest Class Doc Comment * * @category Class * @description GetInboundEmailEventsEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInboundEmailEventsEvents" */ public function testGetInboundEmailEventsEvents() { } /** * Test attribute "uuid" */ public function testPropertyUuid() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "recipient" */ public function testPropertyRecipient() { } } brevo-php/test/Model/OrderBillingTest.php 0000644 00000005707 15021222674 0014424 0 ustar 00 <?php /** * OrderBillingTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * OrderBillingTest Class Doc Comment * * @category Class * @description Billing details of an order. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class OrderBillingTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "OrderBilling" */ public function testOrderBilling() { } /** * Test attribute "address" */ public function testPropertyAddress() { } /** * Test attribute "city" */ public function testPropertyCity() { } /** * Test attribute "countryCode" */ public function testPropertyCountryCode() { } /** * Test attribute "phone" */ public function testPropertyPhone() { } /** * Test attribute "postCode" */ public function testPropertyPostCode() { } /** * Test attribute "paymentMethod" */ public function testPropertyPaymentMethod() { } /** * Test attribute "region" */ public function testPropertyRegion() { } } brevo-php/test/Model/UpdateSenderTest.php 0000644 00000004777 15021222674 0014441 0 ustar 00 <?php /** * UpdateSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateSenderTest Class Doc Comment * * @category Class * @description UpdateSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateSender" */ public function testUpdateSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "ips" */ public function testPropertyIps() { } } brevo-php/test/Model/CreateSmtpEmailTest.php 0000644 00000004706 15021222674 0015065 0 ustar 00 <?php /** * CreateSmtpEmailTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSmtpEmailTest Class Doc Comment * * @category Class * @description CreateSmtpEmail * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpEmailTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSmtpEmail" */ public function testCreateSmtpEmail() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "messageIds" */ public function testPropertyMessageIds() { } } brevo-php/test/Model/CreateDomainModelDnsRecordsDkimRecordTest.php 0000644 00000005404 15021222674 0021311 0 ustar 00 <?php /** * CreateDomainModelDnsRecordsDkimRecordTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateDomainModelDnsRecordsDkimRecordTest Class Doc Comment * * @category Class * @description CreateDomainModelDnsRecordsDkimRecord * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModelDnsRecordsDkimRecordTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateDomainModelDnsRecordsDkimRecord" */ public function testCreateDomainModelDnsRecordsDkimRecord() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "hostName" */ public function testPropertyHostName() { } /** * Test attribute "status" */ public function testPropertyStatus() { } } brevo-php/test/Model/CreateUpdateFolderTest.php 0000644 00000004541 15021222674 0015545 0 ustar 00 <?php /** * CreateUpdateFolderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateFolderTest Class Doc Comment * * @category Class * @description CreateUpdateFolder * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateFolderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateFolder" */ public function testCreateUpdateFolder() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetChildAccountCreationStatusTest.php 0000644 00000004701 15021222674 0017732 0 ustar 00 <?php /** * GetChildAccountCreationStatusTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildAccountCreationStatusTest Class Doc Comment * * @category Class * @description GetChildAccountCreationStatus * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildAccountCreationStatusTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildAccountCreationStatus" */ public function testGetChildAccountCreationStatus() { } /** * Test attribute "childAccountCreated" */ public function testPropertyChildAccountCreated() { } } brevo-php/test/Model/GetTransacEmailsListTest.php 0000644 00000004756 15021222674 0016075 0 ustar 00 <?php /** * GetTransacEmailsListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacEmailsListTest Class Doc Comment * * @category Class * @description GetTransacEmailsList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailsListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacEmailsList" */ public function testGetTransacEmailsList() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "transactionalEmails" */ public function testPropertyTransactionalEmails() { } } brevo-php/test/Model/CreateDomainTest.php 0000644 00000004475 15021222674 0014404 0 ustar 00 <?php /** * CreateDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateDomainTest Class Doc Comment * * @category Class * @description CreateDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateDomain" */ public function testCreateDomain() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetEmailCampaignTest.php 0000644 00000004716 15021222674 0015176 0 ustar 00 <?php /** * GetEmailCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetEmailCampaignTest Class Doc Comment * * @category Class * @description GetEmailCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetEmailCampaign" */ public function testGetEmailCampaign() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "statistics" */ public function testPropertyStatistics() { } } brevo-php/test/Model/UpdateWebhookTest.php 0000644 00000005172 15021222674 0014605 0 ustar 00 <?php /** * UpdateWebhookTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateWebhookTest Class Doc Comment * * @category Class * @description UpdateWebhook * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateWebhookTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateWebhook" */ public function testUpdateWebhook() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "description" */ public function testPropertyDescription() { } /** * Test attribute "events" */ public function testPropertyEvents() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/CreateListTest.php 0000644 00000004632 15021222674 0014103 0 ustar 00 <?php /** * CreateListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateListTest Class Doc Comment * * @category Class * @description CreateList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateList" */ public function testCreateList() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "folderId" */ public function testPropertyFolderId() { } } brevo-php/test/Model/PipelineStageTest.php 0000644 00000004641 15021222674 0014575 0 ustar 00 <?php /** * PipelineStageTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PipelineStageTest Class Doc Comment * * @category Class * @description List of stages * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PipelineStageTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "PipelineStage" */ public function testPipelineStage() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/Body9Test.php 0000644 00000004423 15021222674 0013030 0 ustar 00 <?php /** * Body9Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body9Test Class Doc Comment * * @category Class * @description Body9 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body9Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body9" */ public function testBody9() { } /** * Test attribute "text" */ public function testPropertyText() { } } brevo-php/test/Model/TaskReminderTest.php 0000644 00000005031 15021222674 0014426 0 ustar 00 <?php /** * TaskReminderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * TaskReminderTest Class Doc Comment * * @category Class * @description Task reminder date/time for a task * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskReminderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "TaskReminder" */ public function testTaskReminder() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "unit" */ public function testPropertyUnit() { } /** * Test attribute "types" */ public function testPropertyTypes() { } } brevo-php/test/Model/CreateAttributeEnumerationTest.php 0000644 00000004766 15021222674 0017352 0 ustar 00 <?php /** * CreateAttributeEnumerationTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateAttributeEnumerationTest Class Doc Comment * * @category Class * @description CreateAttributeEnumeration * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateAttributeEnumerationTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateAttributeEnumeration" */ public function testCreateAttributeEnumeration() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "label" */ public function testPropertyLabel() { } } brevo-php/test/Model/GetContactCampaignStatsOpenedTest.php 0000644 00000005332 15021222674 0017707 0 ustar 00 <?php /** * GetContactCampaignStatsOpenedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactCampaignStatsOpenedTest Class Doc Comment * * @category Class * @description GetContactCampaignStatsOpened * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsOpenedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactCampaignStatsOpened" */ public function testGetContactCampaignStatsOpened() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/GetExtendedCampaignStatsTest.php 0000644 00000006250 15021222674 0016721 0 ustar 00 <?php /** * GetExtendedCampaignStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedCampaignStatsTest Class Doc Comment * * @category Class * @description GetExtendedCampaignStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedCampaignStats" */ public function testGetExtendedCampaignStats() { } /** * Test attribute "globalStats" */ public function testPropertyGlobalStats() { } /** * Test attribute "campaignStats" */ public function testPropertyCampaignStats() { } /** * Test attribute "mirrorClick" */ public function testPropertyMirrorClick() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } /** * Test attribute "linksStats" */ public function testPropertyLinksStats() { } /** * Test attribute "statsByDomain" */ public function testPropertyStatsByDomain() { } /** * Test attribute "statsByDevice" */ public function testPropertyStatsByDevice() { } /** * Test attribute "statsByBrowser" */ public function testPropertyStatsByBrowser() { } } brevo-php/test/Model/GetReportsReportsTest.php 0000644 00000007143 15021222674 0015521 0 ustar 00 <?php /** * GetReportsReportsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetReportsReportsTest Class Doc Comment * * @category Class * @description GetReportsReports * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetReportsReportsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetReportsReports" */ public function testGetReportsReports() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "requests" */ public function testPropertyRequests() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "clicks" */ public function testPropertyClicks() { } /** * Test attribute "uniqueClicks" */ public function testPropertyUniqueClicks() { } /** * Test attribute "opens" */ public function testPropertyOpens() { } /** * Test attribute "uniqueOpens" */ public function testPropertyUniqueOpens() { } /** * Test attribute "spamReports" */ public function testPropertySpamReports() { } /** * Test attribute "blocked" */ public function testPropertyBlocked() { } /** * Test attribute "invalid" */ public function testPropertyInvalid() { } /** * Test attribute "unsubscribed" */ public function testPropertyUnsubscribed() { } } brevo-php/test/Model/UpdateSmsCampaignTest.php 0000644 00000006172 15021222674 0015412 0 ustar 00 <?php /** * UpdateSmsCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateSmsCampaignTest Class Doc Comment * * @category Class * @description UpdateSmsCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateSmsCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateSmsCampaign" */ public function testUpdateSmsCampaign() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "content" */ public function testPropertyContent() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "unicodeEnabled" */ public function testPropertyUnicodeEnabled() { } /** * Test attribute "organisationPrefix" */ public function testPropertyOrganisationPrefix() { } /** * Test attribute "unsubscribeInstruction" */ public function testPropertyUnsubscribeInstruction() { } } brevo-php/test/Model/CreateSenderIpsTest.php 0000644 00000005025 15021222674 0015061 0 ustar 00 <?php /** * CreateSenderIpsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSenderIpsTest Class Doc Comment * * @category Class * @description CreateSenderIps * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSenderIpsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSenderIps" */ public function testCreateSenderIps() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } /** * Test attribute "weight" */ public function testPropertyWeight() { } } brevo-php/test/Model/DeleteHardbouncesTest.php 0000644 00000005075 15021222674 0015426 0 ustar 00 <?php /** * DeleteHardbouncesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * DeleteHardbouncesTest Class Doc Comment * * @category Class * @description DeleteHardbounces * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class DeleteHardbouncesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "DeleteHardbounces" */ public function testDeleteHardbounces() { } /** * Test attribute "startDate" */ public function testPropertyStartDate() { } /** * Test attribute "endDate" */ public function testPropertyEndDate() { } /** * Test attribute "contactEmail" */ public function testPropertyContactEmail() { } } brevo-php/test/Model/CreateCategoryModelTest.php 0000644 00000004543 15021222674 0015727 0 ustar 00 <?php /** * CreateCategoryModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateCategoryModelTest Class Doc Comment * * @category Class * @description CreateCategoryModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCategoryModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateCategoryModel" */ public function testCreateCategoryModel() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/CreateUpdateproductTest.php 0000644 00000006553 15021222674 0016017 0 ustar 00 <?php /** * CreateUpdateProductTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateProductTest Class Doc Comment * * @category Class * @description CreateUpdateProduct * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateProductTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateProduct" */ public function testCreateUpdateProduct() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "imageUrl" */ public function testPropertyImageUrl() { } /** * Test attribute "sku" */ public function testPropertySku() { } /** * Test attribute "price" */ public function testPropertyPrice() { } /** * Test attribute "categories" */ public function testPropertyCategories() { } /** * Test attribute "parentId" */ public function testPropertyParentId() { } /** * Test attribute "metaInfo" */ public function testPropertyMetaInfo() { } /** * Test attribute "updateEnabled" */ public function testPropertyUpdateEnabled() { } /** * Test attribute "deletedAt" */ public function testPropertyDeletedAt() { } } brevo-php/test/Model/GetSmsCampaignTest.php 0000644 00000004702 15021222674 0014704 0 ustar 00 <?php /** * GetSmsCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmsCampaignTest Class Doc Comment * * @category Class * @description GetSmsCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmsCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmsCampaign" */ public function testGetSmsCampaign() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "statistics" */ public function testPropertyStatistics() { } } brevo-php/test/Model/UpdateBatchContactsContactsTest.php 0000644 00000006554 15021222674 0017433 0 ustar 00 <?php /** * UpdateBatchContactsContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateBatchContactsContactsTest Class Doc Comment * * @category Class * @description UpdateBatchContactsContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContactsContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateBatchContactsContacts" */ public function testUpdateBatchContactsContacts() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "extId" */ public function testPropertyExtId() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "emailBlacklisted" */ public function testPropertyEmailBlacklisted() { } /** * Test attribute "smsBlacklisted" */ public function testPropertySmsBlacklisted() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "unlinkListIds" */ public function testPropertyUnlinkListIds() { } /** * Test attribute "smtpBlacklistSender" */ public function testPropertySmtpBlacklistSender() { } } brevo-php/test/Model/GetEmailEventReportTest.php 0000644 00000004553 15021222674 0015733 0 ustar 00 <?php /** * GetEmailEventReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetEmailEventReportTest Class Doc Comment * * @category Class * @description GetEmailEventReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailEventReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetEmailEventReport" */ public function testGetEmailEventReport() { } /** * Test attribute "events" */ public function testPropertyEvents() { } } brevo-php/test/Model/GetAccountActivityTest.php 0000644 00000004541 15021222674 0015614 0 ustar 00 <?php /** * GetAccountActivityTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountActivityTest Class Doc Comment * * @category Class * @description GetAccountActivity * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountActivityTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountActivity" */ public function testGetAccountActivity() { } /** * Test attribute "logs" */ public function testPropertyLogs() { } } brevo-php/test/Model/GetCampaignStatsTest.php 0000644 00000007726 15021222674 0015251 0 ustar 00 <?php /** * GetCampaignStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetCampaignStatsTest Class Doc Comment * * @category Class * @description GetCampaignStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetCampaignStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetCampaignStats" */ public function testGetCampaignStats() { } /** * Test attribute "listId" */ public function testPropertyListId() { } /** * Test attribute "uniqueClicks" */ public function testPropertyUniqueClicks() { } /** * Test attribute "clickers" */ public function testPropertyClickers() { } /** * Test attribute "complaints" */ public function testPropertyComplaints() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "sent" */ public function testPropertySent() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "uniqueViews" */ public function testPropertyUniqueViews() { } /** * Test attribute "trackableViews" */ public function testPropertyTrackableViews() { } /** * Test attribute "trackableViewsRate" */ public function testPropertyTrackableViewsRate() { } /** * Test attribute "estimatedViews" */ public function testPropertyEstimatedViews() { } /** * Test attribute "unsubscriptions" */ public function testPropertyUnsubscriptions() { } /** * Test attribute "viewed" */ public function testPropertyViewed() { } /** * Test attribute "deferred" */ public function testPropertyDeferred() { } /** * Test attribute "returnBounce" */ public function testPropertyReturnBounce() { } } brevo-php/test/Model/RemainingCreditModelChildTest.php 0000644 00000004766 15021222674 0017045 0 ustar 00 <?php /** * RemainingCreditModelChildTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RemainingCreditModelChildTest Class Doc Comment * * @category Class * @description Credits remaining for child account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RemainingCreditModelChildTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RemainingCreditModelChild" */ public function testRemainingCreditModelChild() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/AbTestVersionClicksTest.php 0000644 00000004450 15021222674 0015723 0 ustar 00 <?php /** * AbTestVersionClicksTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestVersionClicksTest Class Doc Comment * * @category Class * @description Information on clicked links for a particular version * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionClicksTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestVersionClicks" */ public function testAbTestVersionClicks() { } } brevo-php/test/Model/CreateApiKeyResponseTest.php 0000644 00000004720 15021222674 0016067 0 ustar 00 <?php /** * CreateApiKeyResponseTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateApiKeyResponseTest Class Doc Comment * * @category Class * @description CreateApiKeyResponse * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateApiKeyResponseTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateApiKeyResponse" */ public function testCreateApiKeyResponse() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "key" */ public function testPropertyKey() { } } brevo-php/test/Model/GetProcessesTest.php 0000644 00000004652 15021222674 0014454 0 ustar 00 <?php /** * GetProcessesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetProcessesTest Class Doc Comment * * @category Class * @description GetProcesses * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProcessesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetProcesses" */ public function testGetProcesses() { } /** * Test attribute "processes" */ public function testPropertyProcesses() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetListTest.php 0000644 00000005351 15021222674 0013416 0 ustar 00 <?php /** * GetListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetListTest Class Doc Comment * * @category Class * @description GetList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetList" */ public function testGetList() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "totalBlacklisted" */ public function testPropertyTotalBlacklisted() { } /** * Test attribute "totalSubscribers" */ public function testPropertyTotalSubscribers() { } /** * Test attribute "uniqueSubscribers" */ public function testPropertyUniqueSubscribers() { } } brevo-php/test/Model/SendWhatsappMessageTest.php 0000644 00000005272 15021222674 0015753 0 ustar 00 <?php /** * SendWhatsappMessageTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendWhatsappMessageTest Class Doc Comment * * @category Class * @description SendWhatsappMessage * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendWhatsappMessageTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendWhatsappMessage" */ public function testSendWhatsappMessage() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "senderNumber" */ public function testPropertySenderNumber() { } /** * Test attribute "contactNumbers" */ public function testPropertyContactNumbers() { } } brevo-php/test/Model/AddChildDomainTest.php 0000644 00000004515 15021222674 0014630 0 ustar 00 <?php /** * AddChildDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AddChildDomainTest Class Doc Comment * * @category Class * @description AddChildDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddChildDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AddChildDomain" */ public function testAddChildDomain() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/UploadImageToGalleryTest.php 0000644 00000004726 15021222674 0016062 0 ustar 00 <?php /** * UploadImageToGalleryTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UploadImageToGalleryTest Class Doc Comment * * @category Class * @description UploadImageToGallery * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UploadImageToGalleryTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UploadImageToGallery" */ public function testUploadImageToGallery() { } /** * Test attribute "imageUrl" */ public function testPropertyImageUrl() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/SendReportEmailTest.php 0000644 00000004704 15021222674 0015101 0 ustar 00 <?php /** * SendReportEmailTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendReportEmailTest Class Doc Comment * * @category Class * @description Custom attributes for the report email. * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendReportEmailTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendReportEmail" */ public function testSendReportEmail() { } /** * Test attribute "to" */ public function testPropertyTo() { } /** * Test attribute "body" */ public function testPropertyBody() { } } brevo-php/test/Model/GetWebhooksTest.php 0000644 00000004477 15021222674 0014274 0 ustar 00 <?php /** * GetWebhooksTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWebhooksTest Class Doc Comment * * @category Class * @description GetWebhooks * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWebhooksTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWebhooks" */ public function testGetWebhooks() { } /** * Test attribute "webhooks" */ public function testPropertyWebhooks() { } } brevo-php/test/Model/SendSmtpEmailTo1Test.php 0000644 00000004670 15021222674 0015137 0 ustar 00 <?php /** * SendSmtpEmailTo1Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailTo1Test Class Doc Comment * * @category Class * @description SendSmtpEmailTo1 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailTo1Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailTo1" */ public function testSendSmtpEmailTo1() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/AbTestVersionStatsTest.php 0000644 00000004762 15021222674 0015617 0 ustar 00 <?php /** * AbTestVersionStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AbTestVersionStatsTest Class Doc Comment * * @category Class * @description Percentage of a particular event for both versions * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AbTestVersionStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AbTestVersionStats" */ public function testAbTestVersionStats() { } /** * Test attribute "versionA" */ public function testPropertyVersionA() { } /** * Test attribute "versionB" */ public function testPropertyVersionB() { } } brevo-php/test/Model/GetSmtpTemplateOverviewSenderTest.php 0000644 00000005143 15021222674 0020011 0 ustar 00 <?php /** * GetSmtpTemplateOverviewSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmtpTemplateOverviewSenderTest Class Doc Comment * * @category Class * @description GetSmtpTemplateOverviewSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplateOverviewSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmtpTemplateOverviewSender" */ public function testGetSmtpTemplateOverviewSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/PostContactInfoTest.php 0000644 00000004527 15021222674 0015124 0 ustar 00 <?php /** * PostContactInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PostContactInfoTest Class Doc Comment * * @category Class * @description PostContactInfo * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PostContactInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "PostContactInfo" */ public function testPostContactInfo() { } /** * Test attribute "contacts" */ public function testPropertyContacts() { } } brevo-php/test/Model/CreateSmtpTemplateSenderTest.php 0000644 00000005500 15021222674 0016743 0 ustar 00 <?php /** * CreateSmtpTemplateSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSmtpTemplateSenderTest Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpTemplateSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSmtpTemplateSender" */ public function testCreateSmtpTemplateSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/InlineResponse2001Test.php 0000644 00000005061 15021222674 0015301 0 ustar 00 <?php /** * InlineResponse2001Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse2001Test Class Doc Comment * * @category Class * @description InlineResponse2001 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2001Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse2001" */ public function testInlineResponse2001() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "defaultCoupon" */ public function testPropertyDefaultCoupon() { } } brevo-php/test/Model/CreateSmtpTemplateTest.php 0000644 00000006434 15021222674 0015611 0 ustar 00 <?php /** * CreateSmtpTemplateTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSmtpTemplateTest Class Doc Comment * * @category Class * @description CreateSmtpTemplate * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmtpTemplateTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSmtpTemplate" */ public function testCreateSmtpTemplate() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "templateName" */ public function testPropertyTemplateName() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "htmlUrl" */ public function testPropertyHtmlUrl() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "attachmentUrl" */ public function testPropertyAttachmentUrl() { } /** * Test attribute "isActive" */ public function testPropertyIsActive() { } } brevo-php/test/Model/GetExtendedClientAddressTest.php 0000644 00000005264 15021222674 0016713 0 ustar 00 <?php /** * GetExtendedClientAddressTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedClientAddressTest Class Doc Comment * * @category Class * @description Address informations * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedClientAddressTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedClientAddress" */ public function testGetExtendedClientAddress() { } /** * Test attribute "street" */ public function testPropertyStreet() { } /** * Test attribute "city" */ public function testPropertyCity() { } /** * Test attribute "zipCode" */ public function testPropertyZipCode() { } /** * Test attribute "country" */ public function testPropertyCountry() { } } brevo-php/test/Model/GetClientTest.php 0000644 00000005160 15021222674 0013717 0 ustar 00 <?php /** * GetClientTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetClientTest Class Doc Comment * * @category Class * @description GetClient * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetClientTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetClient" */ public function testGetClient() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "firstName" */ public function testPropertyFirstName() { } /** * Test attribute "lastName" */ public function testPropertyLastName() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } } brevo-php/test/Model/UpdateAttributeTest.php 0000644 00000004700 15021222674 0015146 0 ustar 00 <?php /** * UpdateAttributeTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateAttributeTest Class Doc Comment * * @category Class * @description UpdateAttribute * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateAttributeTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateAttribute" */ public function testUpdateAttribute() { } /** * Test attribute "value" */ public function testPropertyValue() { } /** * Test attribute "enumeration" */ public function testPropertyEnumeration() { } } brevo-php/test/Model/GetAggregatedReportTest.php 0000644 00000007161 15021222674 0015732 0 ustar 00 <?php /** * GetAggregatedReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAggregatedReportTest Class Doc Comment * * @category Class * @description GetAggregatedReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAggregatedReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAggregatedReport" */ public function testGetAggregatedReport() { } /** * Test attribute "range" */ public function testPropertyRange() { } /** * Test attribute "requests" */ public function testPropertyRequests() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "clicks" */ public function testPropertyClicks() { } /** * Test attribute "uniqueClicks" */ public function testPropertyUniqueClicks() { } /** * Test attribute "opens" */ public function testPropertyOpens() { } /** * Test attribute "uniqueOpens" */ public function testPropertyUniqueOpens() { } /** * Test attribute "spamReports" */ public function testPropertySpamReports() { } /** * Test attribute "blocked" */ public function testPropertyBlocked() { } /** * Test attribute "invalid" */ public function testPropertyInvalid() { } /** * Test attribute "unsubscribed" */ public function testPropertyUnsubscribed() { } } brevo-php/test/Model/CompanyTest.php 0000644 00000005200 15021222674 0013442 0 ustar 00 <?php /** * CompanyTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CompanyTest Class Doc Comment * * @category Class * @description Company Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompanyTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Company" */ public function testCompany() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "linkedContactsIds" */ public function testPropertyLinkedContactsIds() { } /** * Test attribute "linkedDealsIds" */ public function testPropertyLinkedDealsIds() { } } brevo-php/test/Model/TaskTest.php 0000644 00000005450 15021222674 0012745 0 ustar 00 <?php /** * TaskTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * TaskTest Class Doc Comment * * @category Class * @description Task Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Task" */ public function testTask() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "taskTypeId" */ public function testPropertyTaskTypeId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "contactsIds" */ public function testPropertyContactsIds() { } /** * Test attribute "dealsIds" */ public function testPropertyDealsIds() { } /** * Test attribute "companiesIds" */ public function testPropertyCompaniesIds() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsLinksTest.php 0000644 00000005416 15021222674 0022143 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsLinksTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsLinksTest Class Doc Comment * * @category Class * @description GetExtendedContactDetailsStatisticsLinks * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsLinksTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsLinks" */ public function testGetExtendedContactDetailsStatisticsLinks() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "eventTime" */ public function testPropertyEventTime() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "url" */ public function testPropertyUrl() { } } brevo-php/test/Model/GetStatsByBrowserTest.php 0000644 00000004372 15021222674 0015442 0 ustar 00 <?php /** * GetStatsByBrowserTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetStatsByBrowserTest Class Doc Comment * * @category Class * @description GetStatsByBrowser * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetStatsByBrowserTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetStatsByBrowser" */ public function testGetStatsByBrowser() { } } brevo-php/test/Model/CreateEmailCampaignRecipientsTest.php 0000644 00000005253 15021222674 0017705 0 ustar 00 <?php /** * CreateEmailCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateEmailCampaignRecipientsTest Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateEmailCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateEmailCampaignRecipients" */ public function testCreateEmailCampaignRecipients() { } /** * Test attribute "exclusionListIds" */ public function testPropertyExclusionListIds() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "segmentIds" */ public function testPropertySegmentIds() { } } brevo-php/test/Model/MasterDetailsResponseBillingInfoAddressTest.php 0000644 00000005633 15021222674 0021751 0 ustar 00 <?php /** * MasterDetailsResponseBillingInfoAddressTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponseBillingInfoAddressTest Class Doc Comment * * @category Class * @description Billing address of master account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponseBillingInfoAddressTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponseBillingInfoAddress" */ public function testMasterDetailsResponseBillingInfoAddress() { } /** * Test attribute "streetAddress" */ public function testPropertyStreetAddress() { } /** * Test attribute "locality" */ public function testPropertyLocality() { } /** * Test attribute "postalCode" */ public function testPropertyPostalCode() { } /** * Test attribute "stateCode" */ public function testPropertyStateCode() { } /** * Test attribute "countryCode" */ public function testPropertyCountryCode() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoTest.php 0000644 00000005212 15021222674 0020561 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoTest Class Doc Comment * * @category Class * @description Sub-account plan details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfo" */ public function testSubAccountDetailsResponsePlanInfo() { } /** * Test attribute "credits" */ public function testPropertyCredits() { } /** * Test attribute "features" */ public function testPropertyFeatures() { } /** * Test attribute "planType" */ public function testPropertyPlanType() { } } brevo-php/test/Model/GetTransacBlockedContactsReasonTest.php 0000644 00000005032 15021222674 0020225 0 ustar 00 <?php /** * GetTransacBlockedContactsReasonTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacBlockedContactsReasonTest Class Doc Comment * * @category Class * @description Reason for blocking / unsubscribing * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContactsReasonTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacBlockedContactsReason" */ public function testGetTransacBlockedContactsReason() { } /** * Test attribute "code" */ public function testPropertyCode() { } /** * Test attribute "message" */ public function testPropertyMessage() { } } brevo-php/test/Model/InlineResponse2011Test.php 0000644 00000004527 15021222674 0015310 0 ustar 00 <?php /** * InlineResponse2011Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse2011Test Class Doc Comment * * @category Class * @description Task Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2011Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse2011" */ public function testInlineResponse2011() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/GetInboundEmailEventsByUuidTest.php 0000644 00000006204 15021222674 0017356 0 ustar 00 <?php /** * GetInboundEmailEventsByUuidTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInboundEmailEventsByUuidTest Class Doc Comment * * @category Class * @description GetInboundEmailEventsByUuid * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsByUuidTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInboundEmailEventsByUuid" */ public function testGetInboundEmailEventsByUuid() { } /** * Test attribute "receivedAt" */ public function testPropertyReceivedAt() { } /** * Test attribute "deliveredAt" */ public function testPropertyDeliveredAt() { } /** * Test attribute "recipient" */ public function testPropertyRecipient() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "attachments" */ public function testPropertyAttachments() { } /** * Test attribute "logs" */ public function testPropertyLogs() { } } brevo-php/test/Model/UpdateWhatsAppCampaignTest.php 0000644 00000005336 15021222674 0016400 0 ustar 00 <?php /** * UpdateWhatsAppCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateWhatsAppCampaignTest Class Doc Comment * * @category Class * @description UpdateWhatsAppCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateWhatsAppCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateWhatsAppCampaign" */ public function testUpdateWhatsAppCampaign() { } /** * Test attribute "campaignName" */ public function testPropertyCampaignName() { } /** * Test attribute "campaignStatus" */ public function testPropertyCampaignStatus() { } /** * Test attribute "rescheduleFor" */ public function testPropertyRescheduleFor() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } } brevo-php/test/Model/SubAccountAppsToggleRequestTest.php 0000644 00000007352 15021222674 0017453 0 ustar 00 <?php /** * SubAccountAppsToggleRequestTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountAppsToggleRequestTest Class Doc Comment * * @category Class * @description List of enable/disable applications on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountAppsToggleRequestTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountAppsToggleRequest" */ public function testSubAccountAppsToggleRequest() { } /** * Test attribute "inbox" */ public function testPropertyInbox() { } /** * Test attribute "whatsapp" */ public function testPropertyWhatsapp() { } /** * Test attribute "automation" */ public function testPropertyAutomation() { } /** * Test attribute "emailCampaigns" */ public function testPropertyEmailCampaigns() { } /** * Test attribute "smsCampaigns" */ public function testPropertySmsCampaigns() { } /** * Test attribute "landingPages" */ public function testPropertyLandingPages() { } /** * Test attribute "transactionalEmails" */ public function testPropertyTransactionalEmails() { } /** * Test attribute "transactionalSms" */ public function testPropertyTransactionalSms() { } /** * Test attribute "facebookAds" */ public function testPropertyFacebookAds() { } /** * Test attribute "webPush" */ public function testPropertyWebPush() { } /** * Test attribute "meetings" */ public function testPropertyMeetings() { } /** * Test attribute "conversations" */ public function testPropertyConversations() { } /** * Test attribute "crm" */ public function testPropertyCrm() { } } brevo-php/test/Model/GetEmailEventReportEventsTest.php 0000644 00000006563 15021222674 0017123 0 ustar 00 <?php /** * GetEmailEventReportEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetEmailEventReportEventsTest Class Doc Comment * * @category Class * @description GetEmailEventReportEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetEmailEventReportEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetEmailEventReportEvents" */ public function testGetEmailEventReportEvents() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "event" */ public function testPropertyEvent() { } /** * Test attribute "reason" */ public function testPropertyReason() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "link" */ public function testPropertyLink() { } /** * Test attribute "from" */ public function testPropertyFrom() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoFeaturesTest.php 0000644 00000005273 15021222674 0022267 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoFeaturesTest Class Doc Comment * * @category Class * @description Features available on the sub-account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoFeatures" */ public function testSubAccountDetailsResponsePlanInfoFeatures() { } /** * Test attribute "inbox" */ public function testPropertyInbox() { } /** * Test attribute "landingPage" */ public function testPropertyLandingPage() { } /** * Test attribute "users" */ public function testPropertyUsers() { } } brevo-php/test/Model/CreateSubAccountTest.php 0000644 00000005230 15021222674 0015231 0 ustar 00 <?php /** * CreateSubAccountTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSubAccountTest Class Doc Comment * * @category Class * @description CreateSubAccount * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSubAccountTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSubAccount" */ public function testCreateSubAccount() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } /** * Test attribute "timezone" */ public function testPropertyTimezone() { } } brevo-php/test/Model/SendSmtpEmailToTest.php 0000644 00000004662 15021222674 0015057 0 ustar 00 <?php /** * SendSmtpEmailToTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailToTest Class Doc Comment * * @category Class * @description SendSmtpEmailTo * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailToTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailTo" */ public function testSendSmtpEmailTo() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetAccountRelayDataTest.php 0000644 00000005116 15021222674 0015665 0 ustar 00 <?php /** * GetAccountRelayDataTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountRelayDataTest Class Doc Comment * * @category Class * @description Data regarding the transactional email account * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountRelayDataTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountRelayData" */ public function testGetAccountRelayData() { } /** * Test attribute "userName" */ public function testPropertyUserName() { } /** * Test attribute "relay" */ public function testPropertyRelay() { } /** * Test attribute "port" */ public function testPropertyPort() { } } brevo-php/test/Model/UpdateBatchContactsModelTest.php 0000644 00000004776 15021222674 0016721 0 ustar 00 <?php /** * UpdateBatchContactsModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateBatchContactsModelTest Class Doc Comment * * @category Class * @description UpdateBatchContactsModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateBatchContactsModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateBatchContactsModel" */ public function testUpdateBatchContactsModel() { } /** * Test attribute "successIds" */ public function testPropertySuccessIds() { } /** * Test attribute "failureIds" */ public function testPropertyFailureIds() { } } brevo-php/test/Model/BodyTest.php 0000644 00000006447 15021222674 0012747 0 ustar 00 <?php /** * BodyTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * BodyTest Class Doc Comment * * @category Class * @description Body * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class BodyTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body" */ public function testBody() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "duration" */ public function testPropertyDuration() { } /** * Test attribute "taskTypeId" */ public function testPropertyTaskTypeId() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "notes" */ public function testPropertyNotes() { } /** * Test attribute "done" */ public function testPropertyDone() { } /** * Test attribute "assignToId" */ public function testPropertyAssignToId() { } /** * Test attribute "contactsIds" */ public function testPropertyContactsIds() { } /** * Test attribute "dealsIds" */ public function testPropertyDealsIds() { } /** * Test attribute "companiesIds" */ public function testPropertyCompaniesIds() { } /** * Test attribute "reminder" */ public function testPropertyReminder() { } } brevo-php/test/Model/SubAccountDetailsResponsePlanInfoFeaturesUsersTest.php 0000644 00000005143 15021222674 0023305 0 ustar 00 <?php /** * SubAccountDetailsResponsePlanInfoFeaturesUsersTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountDetailsResponsePlanInfoFeaturesUsersTest Class Doc Comment * * @category Class * @description Multi-account details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountDetailsResponsePlanInfoFeaturesUsersTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountDetailsResponsePlanInfoFeaturesUsers" */ public function testSubAccountDetailsResponsePlanInfoFeaturesUsers() { } /** * Test attribute "quantity" */ public function testPropertyQuantity() { } /** * Test attribute "remaining" */ public function testPropertyRemaining() { } } brevo-php/test/Model/GetWATemplatesTemplatesTest.php 0000644 00000006132 15021222674 0016546 0 ustar 00 <?php /** * GetWATemplatesTemplatesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWATemplatesTemplatesTest Class Doc Comment * * @category Class * @description GetWATemplatesTemplates * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWATemplatesTemplatesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWATemplatesTemplates" */ public function testGetWATemplatesTemplates() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "status" */ public function testPropertyStatus() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } /** * Test attribute "category" */ public function testPropertyCategory() { } /** * Test attribute "errorReason" */ public function testPropertyErrorReason() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/CreateUpdateBatchProductsTest.php 0000644 00000005006 15021222674 0017074 0 ustar 00 <?php /** * CreateUpdateBatchProductsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateBatchProductsTest Class Doc Comment * * @category Class * @description CreateUpdateBatchProducts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchProductsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateBatchProducts" */ public function testCreateUpdateBatchProducts() { } /** * Test attribute "products" */ public function testPropertyProducts() { } /** * Test attribute "updateEnabled" */ public function testPropertyUpdateEnabled() { } } brevo-php/test/Model/ContactTest.php 0000644 00000006046 15021222674 0013440 0 ustar 00 <?php /** * ContactTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ContactTest Class Doc Comment * * @category Class * @description Contact Details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ContactTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Contact" */ public function testContact() { } /** * Test attribute "virtualNextTask" */ public function testPropertyVirtualNextTask() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "assignToId" */ public function testPropertyAssignToId() { } /** * Test attribute "contactsId" */ public function testPropertyContactsId() { } /** * Test attribute "crmLists" */ public function testPropertyCrmLists() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "updatedAt" */ public function testPropertyUpdatedAt() { } } brevo-php/test/Model/CreateModelTest.php 0000644 00000004463 15021222674 0014232 0 ustar 00 <?php /** * CreateModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateModelTest Class Doc Comment * * @category Class * @description CreateModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateModel" */ public function testCreateModel() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/UpdateExternalFeedTest.php 0000644 00000006225 15021222674 0015555 0 ustar 00 <?php /** * UpdateExternalFeedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateExternalFeedTest Class Doc Comment * * @category Class * @description UpdateExternalFeed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateExternalFeedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateExternalFeed" */ public function testUpdateExternalFeed() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "authType" */ public function testPropertyAuthType() { } /** * Test attribute "username" */ public function testPropertyUsername() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "token" */ public function testPropertyToken() { } /** * Test attribute "headers" */ public function testPropertyHeaders() { } /** * Test attribute "maxRetries" */ public function testPropertyMaxRetries() { } /** * Test attribute "cache" */ public function testPropertyCache() { } } brevo-php/test/Model/GetChildInfoTest.php 0000644 00000005337 15021222674 0014346 0 ustar 00 <?php /** * GetChildInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoTest Class Doc Comment * * @category Class * @description GetChildInfo * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfo" */ public function testGetChildInfo() { } /** * Test attribute "credits" */ public function testPropertyCredits() { } /** * Test attribute "statistics" */ public function testPropertyStatistics() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "ips" */ public function testPropertyIps() { } /** * Test attribute "apiKeys" */ public function testPropertyApiKeys() { } } brevo-php/test/Model/CreateDomainModelDnsRecordsTest.php 0000644 00000005016 15021222674 0017344 0 ustar 00 <?php /** * CreateDomainModelDnsRecordsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateDomainModelDnsRecordsTest Class Doc Comment * * @category Class * @description CreateDomainModelDnsRecords * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateDomainModelDnsRecordsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateDomainModelDnsRecords" */ public function testCreateDomainModelDnsRecords() { } /** * Test attribute "dkimRecord" */ public function testPropertyDkimRecord() { } /** * Test attribute "brevoCode" */ public function testPropertyBrevoCode() { } } brevo-php/test/Model/GetChildInfoApiKeysV3Test.php 0000644 00000004722 15021222674 0016042 0 ustar 00 <?php /** * GetChildInfoApiKeysV3Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildInfoApiKeysV3Test Class Doc Comment * * @category Class * @description GetChildInfoApiKeysV3 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildInfoApiKeysV3Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildInfoApiKeysV3" */ public function testGetChildInfoApiKeysV3() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "key" */ public function testPropertyKey() { } } brevo-php/test/Model/SubAccountsResponseSubAccountsTest.php 0000644 00000005344 15021222674 0020167 0 ustar 00 <?php /** * SubAccountsResponseSubAccountsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountsResponseSubAccountsTest Class Doc Comment * * @category Class * @description SubAccountsResponseSubAccounts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountsResponseSubAccountsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountsResponseSubAccounts" */ public function testSubAccountsResponseSubAccounts() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "companyName" */ public function testPropertyCompanyName() { } /** * Test attribute "active" */ public function testPropertyActive() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } } brevo-php/test/Model/FileDownloadableLinkTest.php 0000644 00000004563 15021222674 0016060 0 ustar 00 <?php /** * FileDownloadableLinkTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * FileDownloadableLinkTest Class Doc Comment * * @category Class * @description FileDownloadableLink * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileDownloadableLinkTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "FileDownloadableLink" */ public function testFileDownloadableLink() { } /** * Test attribute "fileUrl" */ public function testPropertyFileUrl() { } } brevo-php/test/Model/CreateSenderModelTest.php 0000644 00000005053 15021222674 0015367 0 ustar 00 <?php /** * CreateSenderModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSenderModelTest Class Doc Comment * * @category Class * @description CreateSenderModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSenderModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSenderModel" */ public function testCreateSenderModel() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "spfError" */ public function testPropertySpfError() { } /** * Test attribute "dkimError" */ public function testPropertyDkimError() { } } brevo-php/test/Model/CreatedProcessIdTest.php 0000644 00000004537 15021222674 0015233 0 ustar 00 <?php /** * CreatedProcessIdTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreatedProcessIdTest Class Doc Comment * * @category Class * @description CreatedProcessId * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreatedProcessIdTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreatedProcessId" */ public function testCreatedProcessId() { } /** * Test attribute "processId" */ public function testPropertyProcessId() { } } brevo-php/test/Model/GetIpsFromSenderTest.php 0000644 00000004523 15021222674 0015223 0 ustar 00 <?php /** * GetIpsFromSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetIpsFromSenderTest Class Doc Comment * * @category Class * @description GetIpsFromSender * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpsFromSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetIpsFromSender" */ public function testGetIpsFromSender() { } /** * Test attribute "ips" */ public function testPropertyIps() { } } brevo-php/test/Model/UpdateCouponCollectionTest.php 0000644 00000004613 15021222674 0016465 0 ustar 00 <?php /** * UpdateCouponCollectionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateCouponCollectionTest Class Doc Comment * * @category Class * @description UpdateCouponCollection * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateCouponCollectionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateCouponCollection" */ public function testUpdateCouponCollection() { } /** * Test attribute "defaultCoupon" */ public function testPropertyDefaultCoupon() { } } brevo-php/test/Model/RequestContactImportTest.php 0000644 00000006560 15021222674 0016205 0 ustar 00 <?php /** * RequestContactImportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestContactImportTest Class Doc Comment * * @category Class * @description RequestContactImport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactImportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestContactImport" */ public function testRequestContactImport() { } /** * Test attribute "fileUrl" */ public function testPropertyFileUrl() { } /** * Test attribute "fileBody" */ public function testPropertyFileBody() { } /** * Test attribute "jsonBody" */ public function testPropertyJsonBody() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "notifyUrl" */ public function testPropertyNotifyUrl() { } /** * Test attribute "newList" */ public function testPropertyNewList() { } /** * Test attribute "emailBlacklist" */ public function testPropertyEmailBlacklist() { } /** * Test attribute "smsBlacklist" */ public function testPropertySmsBlacklist() { } /** * Test attribute "updateExistingContacts" */ public function testPropertyUpdateExistingContacts() { } /** * Test attribute "emptyContactsAttributes" */ public function testPropertyEmptyContactsAttributes() { } } brevo-php/test/Model/CreateProductModelTest.php 0000644 00000004535 15021222674 0015573 0 ustar 00 <?php /** * CreateProductModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateProductModelTest Class Doc Comment * * @category Class * @description CreateProductModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateProductModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateProductModel" */ public function testCreateProductModel() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/Body3Test.php 0000644 00000004600 15021222674 0013017 0 ustar 00 <?php /** * Body3Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body3Test Class Doc Comment * * @category Class * @description Body3 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body3Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body3" */ public function testBody3() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } } brevo-php/test/Model/GetScheduledEmailByBatchIdTest.php 0000644 00000004773 15021222674 0017074 0 ustar 00 <?php /** * GetScheduledEmailByBatchIdTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetScheduledEmailByBatchIdTest Class Doc Comment * * @category Class * @description GetScheduledEmailByBatchId * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetScheduledEmailByBatchIdTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetScheduledEmailByBatchId" */ public function testGetScheduledEmailByBatchId() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "batches" */ public function testPropertyBatches() { } } brevo-php/test/Model/Body4test.php 0000644 00000004600 15021222674 0013060 0 ustar 00 <?php /** * Body4Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body4Test Class Doc Comment * * @category Class * @description Body4 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body4Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body4" */ public function testBody4() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "attributes" */ public function testPropertyAttributes() { } } brevo-php/test/Model/CreateExternalFeedTest.php 0000644 00000006225 15021222674 0015536 0 ustar 00 <?php /** * CreateExternalFeedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateExternalFeedTest Class Doc Comment * * @category Class * @description CreateExternalFeed * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateExternalFeedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateExternalFeed" */ public function testCreateExternalFeed() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "authType" */ public function testPropertyAuthType() { } /** * Test attribute "username" */ public function testPropertyUsername() { } /** * Test attribute "password" */ public function testPropertyPassword() { } /** * Test attribute "token" */ public function testPropertyToken() { } /** * Test attribute "headers" */ public function testPropertyHeaders() { } /** * Test attribute "maxRetries" */ public function testPropertyMaxRetries() { } /** * Test attribute "cache" */ public function testPropertyCache() { } } brevo-php/test/Model/InlineResponse200Test.php 0000644 00000004530 15021222674 0015220 0 ustar 00 <?php /** * InlineResponse200Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse200Test Class Doc Comment * * @category Class * @description Created company id * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse200Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse200" */ public function testInlineResponse200() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/GetAccountTest.php 0000644 00000005023 15021222674 0014073 0 ustar 00 <?php /** * GetAccountTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountTest Class Doc Comment * * @category Class * @description GetAccount * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccount" */ public function testGetAccount() { } /** * Test attribute "plan" */ public function testPropertyPlan() { } /** * Test attribute "relay" */ public function testPropertyRelay() { } /** * Test attribute "marketingAutomation" */ public function testPropertyMarketingAutomation() { } } brevo-php/test/Model/UpdateEmailCampaignSenderTest.php 0000644 00000005505 15021222674 0017037 0 ustar 00 <?php /** * UpdateEmailCampaignSenderTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateEmailCampaignSenderTest Class Doc Comment * * @category Class * @description Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}` * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateEmailCampaignSenderTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateEmailCampaignSender" */ public function testUpdateEmailCampaignSender() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/TaskTypesTest.php 0000644 00000004623 15021222674 0013773 0 ustar 00 <?php /** * TaskTypesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * TaskTypesTest Class Doc Comment * * @category Class * @description Task types details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class TaskTypesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "TaskTypes" */ public function testTaskTypes() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "title" */ public function testPropertyTitle() { } } brevo-php/test/Model/CompanyAttributesTest.php 0000644 00000004403 15021222674 0015515 0 ustar 00 <?php /** * CompanyAttributesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CompanyAttributesTest Class Doc Comment * * @category Class * @description List of company attributes * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompanyAttributesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CompanyAttributes" */ public function testCompanyAttributes() { } } brevo-php/test/Model/CreateUpdateCategoryTest.php 0000644 00000005407 15021222674 0016111 0 ustar 00 <?php /** * CreateUpdateCategoryTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateCategoryTest Class Doc Comment * * @category Class * @description CreateUpdateCategory * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateCategoryTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateCategory" */ public function testCreateUpdateCategory() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "updateEnabled" */ public function testPropertyUpdateEnabled() { } /** * Test attribute "deletedAt" */ public function testPropertyDeletedAt() { } } brevo-php/test/Model/CreateUpdateBatchCategoryTest.php 0000644 00000005012 15021222674 0017043 0 ustar 00 <?php /** * CreateUpdateBatchCategoryTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateBatchCategoryTest Class Doc Comment * * @category Class * @description CreateUpdateBatchCategory * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateBatchCategoryTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateBatchCategory" */ public function testCreateUpdateBatchCategory() { } /** * Test attribute "categories" */ public function testPropertyCategories() { } /** * Test attribute "updateEnabled" */ public function testPropertyUpdateEnabled() { } } brevo-php/test/Model/GetDomainsListTest.php 0000644 00000004517 15021222674 0014734 0 ustar 00 <?php /** * GetDomainsListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetDomainsListTest Class Doc Comment * * @category Class * @description GetDomainsList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainsListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetDomainsList" */ public function testGetDomainsList() { } /** * Test attribute "domains" */ public function testPropertyDomains() { } } brevo-php/test/Model/CreateWhatsAppTemplateTest.php 0000644 00000005612 15021222674 0016412 0 ustar 00 <?php /** * CreateWhatsAppTemplateTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateWhatsAppTemplateTest Class Doc Comment * * @category Class * @description CreateWhatsAppTemplate * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppTemplateTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateWhatsAppTemplate" */ public function testCreateWhatsAppTemplate() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } /** * Test attribute "category" */ public function testPropertyCategory() { } /** * Test attribute "mediaUrl" */ public function testPropertyMediaUrl() { } /** * Test attribute "bodyText" */ public function testPropertyBodyText() { } /** * Test attribute "headerText" */ public function testPropertyHeaderText() { } } brevo-php/test/Model/GetSegmentsSegmentsTest.php 0000644 00000005256 15021222674 0016002 0 ustar 00 <?php /** * GetSegmentsSegmentsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSegmentsSegmentsTest Class Doc Comment * * @category Class * @description GetSegmentsSegments * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSegmentsSegmentsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSegmentsSegments" */ public function testGetSegmentsSegments() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "segmentName" */ public function testPropertySegmentName() { } /** * Test attribute "categoryName" */ public function testPropertyCategoryName() { } /** * Test attribute "updatedAt" */ public function testPropertyUpdatedAt() { } } brevo-php/test/Model/CreateSmsCampaignTest.php 0000644 00000006172 15021222674 0015373 0 ustar 00 <?php /** * CreateSmsCampaignTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateSmsCampaignTest Class Doc Comment * * @category Class * @description CreateSmsCampaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateSmsCampaignTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateSmsCampaign" */ public function testCreateSmsCampaign() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "content" */ public function testPropertyContent() { } /** * Test attribute "recipients" */ public function testPropertyRecipients() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "unicodeEnabled" */ public function testPropertyUnicodeEnabled() { } /** * Test attribute "organisationPrefix" */ public function testPropertyOrganisationPrefix() { } /** * Test attribute "unsubscribeInstruction" */ public function testPropertyUnsubscribeInstruction() { } } brevo-php/test/Model/GetChildrenListTest.php 0000644 00000004672 15021222674 0015074 0 ustar 00 <?php /** * GetChildrenListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetChildrenListTest Class Doc Comment * * @category Class * @description GetChildrenList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetChildrenListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetChildrenList" */ public function testGetChildrenList() { } /** * Test attribute "children" */ public function testPropertyChildren() { } /** * Test attribute "count" */ public function testPropertyCount() { } } brevo-php/test/Model/GetExtendedCampaignOverviewTest.php 0000644 00000007746 15021222674 0017444 0 ustar 00 <?php /** * GetExtendedCampaignOverviewTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedCampaignOverviewTest Class Doc Comment * * @category Class * @description GetExtendedCampaignOverview * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedCampaignOverviewTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedCampaignOverview" */ public function testGetExtendedCampaignOverview() { } /** * Test attribute "testSent" */ public function testPropertyTestSent() { } /** * Test attribute "header" */ public function testPropertyHeader() { } /** * Test attribute "footer" */ public function testPropertyFooter() { } /** * Test attribute "sender" */ public function testPropertySender() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "toField" */ public function testPropertyToField() { } /** * Test attribute "htmlContent" */ public function testPropertyHtmlContent() { } /** * Test attribute "shareLink" */ public function testPropertyShareLink() { } /** * Test attribute "tag" */ public function testPropertyTag() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } /** * Test attribute "inlineImageActivation" */ public function testPropertyInlineImageActivation() { } /** * Test attribute "mirrorActive" */ public function testPropertyMirrorActive() { } /** * Test attribute "recurring" */ public function testPropertyRecurring() { } /** * Test attribute "sentDate" */ public function testPropertySentDate() { } /** * Test attribute "returnBounce" */ public function testPropertyReturnBounce() { } } brevo-php/test/Model/InlineResponse201Test.php 0000644 00000004525 15021222674 0015225 0 ustar 00 <?php /** * InlineResponse201Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse201Test Class Doc Comment * * @category Class * @description Created deal id * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse201Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse201" */ public function testInlineResponse201() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/RequestSmsRecipientExportTest.php 0000644 00000005012 15021222674 0017215 0 ustar 00 <?php /** * RequestSmsRecipientExportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestSmsRecipientExportTest Class Doc Comment * * @category Class * @description RequestSmsRecipientExport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestSmsRecipientExportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestSmsRecipientExport" */ public function testRequestSmsRecipientExport() { } /** * Test attribute "notifyURL" */ public function testPropertyNotifyURL() { } /** * Test attribute "recipientsType" */ public function testPropertyRecipientsType() { } } brevo-php/test/Model/ScheduleSmtpEmailTest.php 0000644 00000005071 15021222674 0015412 0 ustar 00 <?php /** * ScheduleSmtpEmailTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ScheduleSmtpEmailTest Class Doc Comment * * @category Class * @description ScheduleSmtpEmail * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ScheduleSmtpEmailTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ScheduleSmtpEmail" */ public function testScheduleSmtpEmail() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "messageIds" */ public function testPropertyMessageIds() { } /** * Test attribute "batchId" */ public function testPropertyBatchId() { } } brevo-php/test/Model/CreateWhatsAppCampaignRecipientsTest.php 0000644 00000005264 15021222674 0020407 0 ustar 00 <?php /** * CreateWhatsAppCampaignRecipientsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateWhatsAppCampaignRecipientsTest Class Doc Comment * * @category Class * @description Segment ids and List ids to include/exclude from campaign * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWhatsAppCampaignRecipientsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateWhatsAppCampaignRecipients" */ public function testCreateWhatsAppCampaignRecipients() { } /** * Test attribute "excludedListIds" */ public function testPropertyExcludedListIds() { } /** * Test attribute "listIds" */ public function testPropertyListIds() { } /** * Test attribute "segments" */ public function testPropertySegments() { } } brevo-php/test/Model/GetWhatsappCampaignsCampaignsTest.php 0000644 00000006777 15021222674 0017755 0 ustar 00 <?php /** * GetWhatsappCampaignsCampaignsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetWhatsappCampaignsCampaignsTest Class Doc Comment * * @category Class * @description GetWhatsappCampaignsCampaigns * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetWhatsappCampaignsCampaignsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetWhatsappCampaignsCampaigns" */ public function testGetWhatsappCampaignsCampaigns() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "campaignName" */ public function testPropertyCampaignName() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "campaignStatus" */ public function testPropertyCampaignStatus() { } /** * Test attribute "scheduledAt" */ public function testPropertyScheduledAt() { } /** * Test attribute "errorReason" */ public function testPropertyErrorReason() { } /** * Test attribute "invalidatedContacts" */ public function testPropertyInvalidatedContacts() { } /** * Test attribute "readPercentage" */ public function testPropertyReadPercentage() { } /** * Test attribute "stats" */ public function testPropertyStats() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } } brevo-php/test/Model/GetTransacEmailsListTransactionalEmailsTest.php 0000644 00000006244 15021222674 0021745 0 ustar 00 <?php /** * GetTransacEmailsListTransactionalEmailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacEmailsListTransactionalEmailsTest Class Doc Comment * * @category Class * @description GetTransacEmailsListTransactionalEmails * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacEmailsListTransactionalEmailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacEmailsListTransactionalEmails" */ public function testGetTransacEmailsListTransactionalEmails() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "subject" */ public function testPropertySubject() { } /** * Test attribute "templateId" */ public function testPropertyTemplateId() { } /** * Test attribute "messageId" */ public function testPropertyMessageId() { } /** * Test attribute "uuid" */ public function testPropertyUuid() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "from" */ public function testPropertyFrom() { } /** * Test attribute "tags" */ public function testPropertyTags() { } } brevo-php/test/Model/FileDataTest.php 0000644 00000006316 15021222674 0013516 0 ustar 00 <?php /** * FileDataTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * FileDataTest Class Doc Comment * * @category Class * @description File data that is uploaded * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileDataTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "FileData" */ public function testFileData() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "authorId" */ public function testPropertyAuthorId() { } /** * Test attribute "contactId" */ public function testPropertyContactId() { } /** * Test attribute "dealId" */ public function testPropertyDealId() { } /** * Test attribute "companyId" */ public function testPropertyCompanyId() { } /** * Test attribute "size" */ public function testPropertySize() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "updatedAt" */ public function testPropertyUpdatedAt() { } } brevo-php/test/Model/BlockDomainTest.php 0000644 00000004473 15021222674 0014231 0 ustar 00 <?php /** * BlockDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * BlockDomainTest Class Doc Comment * * @category Class * @description BlockDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class BlockDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "BlockDomain" */ public function testBlockDomain() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/GetIpTest.php 0000644 00000005066 15021222674 0013056 0 ustar 00 <?php /** * GetIpTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetIpTest Class Doc Comment * * @category Class * @description GetIp * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetIp" */ public function testGetIp() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "ip" */ public function testPropertyIp() { } /** * Test attribute "active" */ public function testPropertyActive() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/SendSmtpEmailMessageVersionsTest.php 0000644 00000005610 15021222674 0017604 0 ustar 00 <?php /** * SendSmtpEmailMessageVersionsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailMessageVersionsTest Class Doc Comment * * @category Class * @description SendSmtpEmailMessageVersions * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailMessageVersionsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailMessageVersions" */ public function testSendSmtpEmailMessageVersions() { } /** * Test attribute "to" */ public function testPropertyTo() { } /** * Test attribute "params" */ public function testPropertyParams() { } /** * Test attribute "bcc" */ public function testPropertyBcc() { } /** * Test attribute "cc" */ public function testPropertyCc() { } /** * Test attribute "replyTo" */ public function testPropertyReplyTo() { } /** * Test attribute "subject" */ public function testPropertySubject() { } } brevo-php/test/Model/SendTestEmailTest.php 0000644 00000004511 15021222674 0014541 0 ustar 00 <?php /** * SendTestEmailTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendTestEmailTest Class Doc Comment * * @category Class * @description SendTestEmail * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendTestEmailTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendTestEmail" */ public function testSendTestEmail() { } /** * Test attribute "emailTo" */ public function testPropertyEmailTo() { } } brevo-php/test/Model/PipelinesTest.php 0000644 00000004321 15021222674 0013767 0 ustar 00 <?php /** * PipelinesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * PipelinesTest Class Doc Comment * * @category Class * @description List of pipeline * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class PipelinesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Pipelines" */ public function testPipelines() { } } brevo-php/test/Model/GetExtendedContactDetailsStatisticsUnsubscriptionsTest.php 0000644 00000005267 15021222674 0024301 0 ustar 00 <?php /** * GetExtendedContactDetailsStatisticsUnsubscriptionsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetExtendedContactDetailsStatisticsUnsubscriptionsTest Class Doc Comment * * @category Class * @description Listing of the unsubscription for the contact * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetExtendedContactDetailsStatisticsUnsubscriptionsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetExtendedContactDetailsStatisticsUnsubscriptions" */ public function testGetExtendedContactDetailsStatisticsUnsubscriptions() { } /** * Test attribute "userUnsubscription" */ public function testPropertyUserUnsubscription() { } /** * Test attribute "adminUnsubscription" */ public function testPropertyAdminUnsubscription() { } } brevo-php/test/Model/UpdateListTest.php 0000644 00000004632 15021222674 0014122 0 ustar 00 <?php /** * UpdateListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateListTest Class Doc Comment * * @category Class * @description UpdateList * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateList" */ public function testUpdateList() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "folderId" */ public function testPropertyFolderId() { } } brevo-php/test/Model/ErrorModelTest.php 0000644 00000004630 15021222674 0014114 0 ustar 00 <?php /** * ErrorModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ErrorModelTest Class Doc Comment * * @category Class * @description ErrorModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ErrorModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ErrorModel" */ public function testErrorModel() { } /** * Test attribute "code" */ public function testPropertyCode() { } /** * Test attribute "message" */ public function testPropertyMessage() { } } brevo-php/test/Model/FIleListTest.php 0000644 00000004311 15021222674 0013511 0 ustar 00 <?php /** * FileListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * FileListTest Class Doc Comment * * @category Class * @description List of files * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class FileListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "FileList" */ public function testFileList() { } } brevo-php/test/Model/GetContactCampaignStatsClickedTest.php 0000644 00000005030 15021222674 0020026 0 ustar 00 <?php /** * GetContactCampaignStatsClickedTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetContactCampaignStatsClickedTest Class Doc Comment * * @category Class * @description GetContactCampaignStatsClicked * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetContactCampaignStatsClickedTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetContactCampaignStatsClicked" */ public function testGetContactCampaignStatsClicked() { } /** * Test attribute "campaignId" */ public function testPropertyCampaignId() { } /** * Test attribute "links" */ public function testPropertyLinks() { } } brevo-php/test/Model/InlineResponse2014Test.php 0000644 00000004535 15021222674 0015312 0 ustar 00 <?php /** * InlineResponse2014Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * InlineResponse2014Test Class Doc Comment * * @category Class * @description InlineResponse2014 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class InlineResponse2014Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "InlineResponse2014" */ public function testInlineResponse2014() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/RequestContactExportTest.php 0000644 00000005157 15021222674 0016215 0 ustar 00 <?php /** * RequestContactExportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * RequestContactExportTest Class Doc Comment * * @category Class * @description RequestContactExport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class RequestContactExportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "RequestContactExport" */ public function testRequestContactExport() { } /** * Test attribute "exportAttributes" */ public function testPropertyExportAttributes() { } /** * Test attribute "customContactFilter" */ public function testPropertyCustomContactFilter() { } /** * Test attribute "notifyUrl" */ public function testPropertyNotifyUrl() { } } brevo-php/test/Model/CompaniesListTest.php 0000644 00000004511 15021222674 0014612 0 ustar 00 <?php /** * CompaniesListTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CompaniesListTest Class Doc Comment * * @category Class * @description List of companies * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CompaniesListTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CompaniesList" */ public function testCompaniesList() { } /** * Test attribute "items" */ public function testPropertyItems() { } } brevo-php/test/Model/GetTransacBlockedContactsTest.php 0000644 00000004766 15021222674 0017072 0 ustar 00 <?php /** * GetTransacBlockedContactsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacBlockedContactsTest Class Doc Comment * * @category Class * @description GetTransacBlockedContacts * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacBlockedContactsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacBlockedContacts" */ public function testGetTransacBlockedContacts() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "contacts" */ public function testPropertyContacts() { } } brevo-php/test/Model/ConversationsMessageTest.php 0000644 00000006421 15021222674 0016204 0 ustar 00 <?php /** * ConversationsMessageTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * ConversationsMessageTest Class Doc Comment * * @category Class * @description a Conversations message * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class ConversationsMessageTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "ConversationsMessage" */ public function testConversationsMessage() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "visitorId" */ public function testPropertyVisitorId() { } /** * Test attribute "agentId" */ public function testPropertyAgentId() { } /** * Test attribute "agentName" */ public function testPropertyAgentName() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "isPushed" */ public function testPropertyIsPushed() { } /** * Test attribute "receivedFrom" */ public function testPropertyReceivedFrom() { } /** * Test attribute "file" */ public function testPropertyFile() { } } brevo-php/test/Model/GetIpsTest.php 0000644 00000004427 15021222674 0013241 0 ustar 00 <?php /** * GetIpsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetIpsTest Class Doc Comment * * @category Class * @description GetIps * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetIpsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetIps" */ public function testGetIps() { } /** * Test attribute "ips" */ public function testPropertyIps() { } } brevo-php/test/Model/CreateWebhookTest.php 0000644 00000005333 15021222674 0014565 0 ustar 00 <?php /** * CreateWebhookTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateWebhookTest Class Doc Comment * * @category Class * @description CreateWebhook * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateWebhookTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateWebhook" */ public function testCreateWebhook() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "description" */ public function testPropertyDescription() { } /** * Test attribute "events" */ public function testPropertyEvents() { } /** * Test attribute "type" */ public function testPropertyType() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/CreateUpdateContactModelTest.php 0000644 00000004601 15021222674 0016703 0 ustar 00 <?php /** * CreateUpdateContactModelTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateUpdateContactModelTest Class Doc Comment * * @category Class * @description CreateUpdateContactModel * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateUpdateContactModelTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateUpdateContactModel" */ public function testCreateUpdateContactModel() { } /** * Test attribute "id" */ public function testPropertyId() { } } brevo-php/test/Model/WhatsappCampStatsTest.php 0000644 00000005375 15021222674 0015460 0 ustar 00 <?php /** * WhatsappCampStatsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * WhatsappCampStatsTest Class Doc Comment * * @category Class * @description WhatsappCampStats * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class WhatsappCampStatsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "WhatsappCampStats" */ public function testWhatsappCampStats() { } /** * Test attribute "sent" */ public function testPropertySent() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "read" */ public function testPropertyRead() { } /** * Test attribute "unsubscribe" */ public function testPropertyUnsubscribe() { } /** * Test attribute "notSent" */ public function testPropertyNotSent() { } } brevo-php/test/Model/Body10Test.php 0000644 00000005122 15021222674 0013075 0 ustar 00 <?php /** * Body10Test * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * Body10Test Class Doc Comment * * @category Class * @description Body10 * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class Body10Test extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "Body10" */ public function testBody10() { } /** * Test attribute "visitorId" */ public function testPropertyVisitorId() { } /** * Test attribute "text" */ public function testPropertyText() { } /** * Test attribute "agentId" */ public function testPropertyAgentId() { } /** * Test attribute "groupId" */ public function testPropertyGroupId() { } } brevo-php/test/Model/UpdateChildAccountStatusTest.php 0000644 00000005410 15021222674 0016746 0 ustar 00 <?php /** * UpdateChildAccountStatusTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateChildAccountStatusTest Class Doc Comment * * @category Class * @description UpdateChildAccountStatus * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChildAccountStatusTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateChildAccountStatus" */ public function testUpdateChildAccountStatus() { } /** * Test attribute "transactionalEmail" */ public function testPropertyTransactionalEmail() { } /** * Test attribute "transactionalSms" */ public function testPropertyTransactionalSms() { } /** * Test attribute "marketingAutomation" */ public function testPropertyMarketingAutomation() { } /** * Test attribute "smsCampaign" */ public function testPropertySmsCampaign() { } } brevo-php/test/Model/GetInboundEmailEventsTest.php 0000644 00000004567 15021222674 0016246 0 ustar 00 <?php /** * GetInboundEmailEventsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetInboundEmailEventsTest Class Doc Comment * * @category Class * @description GetInboundEmailEvents * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetInboundEmailEventsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetInboundEmailEvents" */ public function testGetInboundEmailEvents() { } /** * Test attribute "events" */ public function testPropertyEvents() { } } brevo-php/test/Model/AddCreditsTest.php 0000644 00000004622 15021222674 0014051 0 ustar 00 <?php /** * AddCreditsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * AddCreditsTest Class Doc Comment * * @category Class * @description AddCredits * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class AddCreditsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "AddCredits" */ public function testAddCredits() { } /** * Test attribute "sms" */ public function testPropertySms() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/SendReportTest.php 0000644 00000004634 15021222674 0014133 0 ustar 00 <?php /** * SendReportTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendReportTest Class Doc Comment * * @category Class * @description SendReport * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendReportTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendReport" */ public function testSendReport() { } /** * Test attribute "language" */ public function testPropertyLanguage() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/SendSmtpEmailCcTest.php 0000644 00000004662 15021222674 0015022 0 ustar 00 <?php /** * SendSmtpEmailCcTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SendSmtpEmailCcTest Class Doc Comment * * @category Class * @description SendSmtpEmailCc * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SendSmtpEmailCcTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SendSmtpEmailCc" */ public function testSendSmtpEmailCc() { } /** * Test attribute "email" */ public function testPropertyEmail() { } /** * Test attribute "name" */ public function testPropertyName() { } } brevo-php/test/Model/GetAccountActivityLogsTest.php 0000644 00000005431 15021222674 0016440 0 ustar 00 <?php /** * GetAccountActivityLogsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetAccountActivityLogsTest Class Doc Comment * * @category Class * @description GetAccountActivityLogs * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetAccountActivityLogsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetAccountActivityLogs" */ public function testGetAccountActivityLogs() { } /** * Test attribute "action" */ public function testPropertyAction() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "userEmail" */ public function testPropertyUserEmail() { } /** * Test attribute "userIp" */ public function testPropertyUserIp() { } /** * Test attribute "userAgent" */ public function testPropertyUserAgent() { } } brevo-php/test/Model/SubAccountUpdatePlanRequestCreditsTest.php 0000644 00000004671 15021222674 0020762 0 ustar 00 <?php /** * SubAccountUpdatePlanRequestCreditsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * SubAccountUpdatePlanRequestCreditsTest Class Doc Comment * * @category Class * @description Credit details to update * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class SubAccountUpdatePlanRequestCreditsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "SubAccountUpdatePlanRequestCredits" */ public function testSubAccountUpdatePlanRequestCredits() { } /** * Test attribute "email" */ public function testPropertyEmail() { } } brevo-php/test/Model/MasterDetailsResponsePlanInfoTest.php 0000644 00000005675 15021222674 0017763 0 ustar 00 <?php /** * MasterDetailsResponsePlanInfoTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * MasterDetailsResponsePlanInfoTest Class Doc Comment * * @category Class * @description Plan details * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class MasterDetailsResponsePlanInfoTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "MasterDetailsResponsePlanInfo" */ public function testMasterDetailsResponsePlanInfo() { } /** * Test attribute "currencyCode" */ public function testPropertyCurrencyCode() { } /** * Test attribute "nextBillingAt" */ public function testPropertyNextBillingAt() { } /** * Test attribute "price" */ public function testPropertyPrice() { } /** * Test attribute "planPeriod" */ public function testPropertyPlanPeriod() { } /** * Test attribute "subAccounts" */ public function testPropertySubAccounts() { } /** * Test attribute "features" */ public function testPropertyFeatures() { } } brevo-php/test/Model/GetDomainsListDomainsTest.php 0000644 00000005425 15021222674 0016246 0 ustar 00 <?php /** * GetDomainsListDomainsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetDomainsListDomainsTest Class Doc Comment * * @category Class * @description GetDomainsListDomains * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetDomainsListDomainsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetDomainsListDomains" */ public function testGetDomainsListDomains() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "domainName" */ public function testPropertyDomainName() { } /** * Test attribute "authenticated" */ public function testPropertyAuthenticated() { } /** * Test attribute "verified" */ public function testPropertyVerified() { } /** * Test attribute "ip" */ public function testPropertyIp() { } } brevo-php/test/Model/GetTransacSmsReportReportsTest.php 0000644 00000006524 15021222674 0017337 0 ustar 00 <?php /** * GetTransacSmsReportReportsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetTransacSmsReportReportsTest Class Doc Comment * * @category Class * @description GetTransacSmsReportReports * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetTransacSmsReportReportsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetTransacSmsReportReports" */ public function testGetTransacSmsReportReports() { } /** * Test attribute "date" */ public function testPropertyDate() { } /** * Test attribute "requests" */ public function testPropertyRequests() { } /** * Test attribute "delivered" */ public function testPropertyDelivered() { } /** * Test attribute "hardBounces" */ public function testPropertyHardBounces() { } /** * Test attribute "softBounces" */ public function testPropertySoftBounces() { } /** * Test attribute "blocked" */ public function testPropertyBlocked() { } /** * Test attribute "unsubscribed" */ public function testPropertyUnsubscribed() { } /** * Test attribute "replied" */ public function testPropertyReplied() { } /** * Test attribute "accepted" */ public function testPropertyAccepted() { } /** * Test attribute "rejected" */ public function testPropertyRejected() { } } brevo-php/test/Model/GetSmtpTemplatesTest.php 0000644 00000004702 15021222674 0015304 0 ustar 00 <?php /** * GetSmtpTemplatesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetSmtpTemplatesTest Class Doc Comment * * @category Class * @description GetSmtpTemplates * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetSmtpTemplatesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetSmtpTemplates" */ public function testGetSmtpTemplates() { } /** * Test attribute "count" */ public function testPropertyCount() { } /** * Test attribute "templates" */ public function testPropertyTemplates() { } } brevo-php/test/Model/CreateCouponCollectionTest.php 0000644 00000004754 15021222674 0016454 0 ustar 00 <?php /** * CreateCouponCollectionTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * CreateCouponCollectionTest Class Doc Comment * * @category Class * @description CreateCouponCollection * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class CreateCouponCollectionTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "CreateCouponCollection" */ public function testCreateCouponCollection() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "defaultCoupon" */ public function testPropertyDefaultCoupon() { } } brevo-php/test/Model/GetProductDetailsTest.php 0000644 00000007435 15021222674 0015436 0 ustar 00 <?php /** * GetProductDetailsTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetProductDetailsTest Class Doc Comment * * @category Class * @description GetProductDetails * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetProductDetailsTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetProductDetails" */ public function testGetProductDetails() { } /** * Test attribute "id" */ public function testPropertyId() { } /** * Test attribute "name" */ public function testPropertyName() { } /** * Test attribute "createdAt" */ public function testPropertyCreatedAt() { } /** * Test attribute "modifiedAt" */ public function testPropertyModifiedAt() { } /** * Test attribute "url" */ public function testPropertyUrl() { } /** * Test attribute "imageUrl" */ public function testPropertyImageUrl() { } /** * Test attribute "sku" */ public function testPropertySku() { } /** * Test attribute "price" */ public function testPropertyPrice() { } /** * Test attribute "categories" */ public function testPropertyCategories() { } /** * Test attribute "parentId" */ public function testPropertyParentId() { } /** * Test attribute "s3Original" */ public function testPropertyS3Original() { } /** * Test attribute "s3ThumbAnalytics" */ public function testPropertyS3ThumbAnalytics() { } /** * Test attribute "metaInfo" */ public function testPropertyMetaInfo() { } /** * Test attribute "s3ThumbEditor" */ public function testPropertyS3ThumbEditor() { } /** * Test attribute "isDeleted" */ public function testPropertyIsDeleted() { } } brevo-php/test/Model/UpdateChildDomainTest.php 0000644 00000004537 15021222674 0015366 0 ustar 00 <?php /** * UpdateChildDomainTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * UpdateChildDomainTest Class Doc Comment * * @category Class * @description UpdateChildDomain * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class UpdateChildDomainTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "UpdateChildDomain" */ public function testUpdateChildDomain() { } /** * Test attribute "domain" */ public function testPropertyDomain() { } } brevo-php/test/Model/GetUserPermissionPrivilegesTest.php 0000644 00000005014 15021222674 0017520 0 ustar 00 <?php /** * GetUserPermissionPrivilegesTest * * PHP version 5 * * @category Class * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ /** * Brevo API * * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | * * OpenAPI spec version: 3.0.0 * Contact: contact@brevo.com * Generated by: https://github.com/swagger-api/swagger-codegen.git * Swagger Codegen version: 2.4.29 */ /** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen * Please update the test case below to test the model. */ namespace Brevo\Client; /** * GetUserPermissionPrivilegesTest Class Doc Comment * * @category Class * @description GetUserPermissionPrivileges * @package Brevo\Client * @author Swagger Codegen team * @link https://github.com/swagger-api/swagger-codegen */ class GetUserPermissionPrivilegesTest extends \PHPUnit_Framework_TestCase { /** * Setup before running any test case */ public static function setUpBeforeClass() { } /** * Setup before running each test case */ public function setUp() { } /** * Clean up after running each test case */ public function tearDown() { } /** * Clean up after running all test cases */ public static function tearDownAfterClass() { } /** * Test "GetUserPermissionPrivileges" */ public function testGetUserPermissionPrivileges() { } /** * Test attribute "feature" */ public function testPropertyFeature() { } /** * Test attribute "permissions" */ public function testPropertyPermissions() { } }
| ver. 1.4 |
Github
|
.
| PHP 8.1.29 | Генерация страницы: 0.99 |
proxy
|
phpinfo
|
Настройка